PowerShell Help Deep Dive

Slides and supporting tools for help talks and workshops
http://github.com/juneb/PowerShellHelpDeepDive

June Blender
Technology Evangelist
SAPIEN Technologies, Inc.
Windows PowerShell (CDM) MVP
[email protected]
@juneb_get\_help

More presentation content by JuneB:
Pester Test-Driven Development
Thinking in Events (PowerShell GUI Apps)
Class of Wine (PowerShell 5.0 Classes)

PowerShell Help Deep Dive (PowerShell Summit 2015)

• Full session: PowerShell Help DeepDive.pptx
• 40-minute session: PowerShell Help DeepDive-AsDelivered.pptx
• Sample of help written by using the checklists: Get-LoremIpsum-help.xml
• Template for comment-based help syntax: Comment-based-help-template.txt

Professional PowerShell Help for Modules
 -- PowerShell Conference Europe 2016
 -- PowerShell Conference Asia 2016

--

• Presentation slides: PowerShellHelpForModules.zip
  (Also at http://www.slideshare.net/JuneBlender/professional-help-for-powershell-modules)
• About topic template: about\_Topic_Template.help.txt
• Sample of About help written by using the template: about_Pester.help.txt

Bonus Content

• Checklists for authoring PowerShell help: Checklists for Authoring PowerShell Help.pptx
• Comment-based help snippet for Visual Studio and PowerShell Studio: Comment Based Help.snippet
• Proposed model for About help for scripted classes in PowerShell 5.0: about_WineGlass.help.txt
• Pester test for help in any module: -- Module.Help.Tests.ps1, InModue.Help.Tests.ps1