Documentation Resources

A place to capture resources to help in writing docs

General

• http://www.writethedocs.org/ ** http://developers.slashdot.org/story/15/12/09/2041212/write-the-docs-helps-create-floss-software-documentation-video ** http://developers.slashdot.org/story/15/12/11/2136229/write-the-docs-helps-create-floss-software-documentation-video-2 ** http://docs.writethedocs.org/starting/

C#

• https://msdn.microsoft.com/en-us/library/b2s063f7(v=vs.100).aspx
• https://github.com/EWSoftware/SHFB

PowerShell

• https://technet.microsoft.com/en-us/library/hh847834.aspx

• https://msdn.microsoft.com/en-us/library/dn622032.aspx

• https://technet.microsoft.com/en-us/magazine/ff458353.aspx

• http://ben.neise.co.uk/index.php/2014/10/scriptdocumentationinmarkdown/ - converts to MD which can be hosted on GitHub

• https://www.simple-talk.com/sysadmin/powershell/how-to-document-your-powershell-library/

• https://www.red-gate.com/blog/providing-help-docs-powershell-cmdlets ** https://github.com/red-gate/XmlDoc2CmdletDoc

• http://blogs.msdn.com/b/powershell/archive/2007/09/01/new-and-improved-cmdlet-help-editor-tool.aspx

• https://cmille19.wordpress.com/2009/09/24/external-maml-help-files/ ** http://stackoverflow.com/questions/2367333/powershell-maml-help-generator ** http://poshcode.org/1338

• https://chaseflorell.github.io/powershell/2015/04/27/how-to-generate-beautiful-powershell-documentation/

• Writing MAML help docs for binary PS modules:

  • http://poshbuild.codeplex.com/
  • https://cmdlethelpeditor.codeplex.com/ - MS official tool, but now defunct
  • https://pscmdlethelpeditor.codeplex.com/ - OSS replacement for defunct MS tool
  • https://github.com/red-gate/XmlDoc2CmdletDoc