Knowledge management

Before you start thinking about any kind of NuGet repository to host your PowerShell modules, we need to talk about knowledge management. Proper knowledge management is key to a great and widely accepted PowerShell repository.

Scripts, modules, DSC resources, and so on will only be widely used if the documentation is well written and can easily be searched. The following example for the AutomatedLab module is a showcase of good documentation:


The AutomatedLab project uses GitHub's markdown-powered wiki to document everything. Working with markdown is a very easy way to include documentation in your projects. GitHub provides a separate repository for your wiki that you can clone locally and contribute to. It also provides a web interface with an editor that is very easy to use for non-developers as well.

GitHub is very well-suited to organizations that are fine with their code and documentation being stored in the cloud. Other providers will give you a similarly easy experience when editing documentation:

The most important thing to consider when thinking about a wiki is, will my users love using it? If you cannot give a positive answer to this question, your documentation solution is probably not the best fit. Documenting code is always a hassle, so you need to enable your developers and operations staff to begin to like documenting.

Organizations already using Atlassian Jira as an issue tracker might want to use Confluence for a seamless experience. Others might find OneNote to be an excellent tool, as it supports parallel access and has a powerful integrated search tool. You may even want to give SharePoint a try. Of course, there are also free solutions available, such as DokuWiki, MediaWiki, MoinMoin, and many, many more:

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
3.141.193.158