PowerShell Tool Time: Building Help

• Mike Fal

  SSC Veteran

  Points: 265

  More actions

  January 6, 2016 at 12:05 am

  #323366

  Comments posted to this topic are about the item PowerShell Tool Time: Building Help

• akljfhnlaflkj

  SSC Guru

  Points: 76202

  More actions

  January 6, 2016 at 6:22 am

  #1849818

  Thanks for another good article in this series.

• cmant

  Grasshopper

  Points: 22

  More actions

  January 6, 2016 at 6:42 am

  #1849827

  Hi Mike. Excellent article...and series! I just went back and got caught up on the previous articles.

• msorens

  SSC Veteran

  Points: 288

  More actions

  January 6, 2016 at 8:48 am

  #1849887

  A good introduction to documenting cmdlets! The next step to consider is publishing your entire API (i.e. the help from all your cmdlets together). There is unfortunately no built-in support for doing this so some time ago I created DocTreeGenerator (https://github.com/msorens/DocTreeGenerator) to generate a complete web tree of your PowerShell API. And just in the last few weeks I dusted it off, added lots of enhancements and updates, and moved it to github. You can read my original article (still quite valid) on how to use it at SqlServerCentral.com's sister site: https://www.simple-talk.com/sysadmin/powershell/how-to-document-your-powershell-library/