Introduction To PowerShell Help Writer 2015 #SAPIEN #PowerShell @SAPIENTech

As the name state, PowerShell HelpWriter is designed for writing and editing Windows PowerShell help files.

SAPIEN Technologies has added a new product to their Portfolio called PowerShell HelpWriter 2015 to help you create and edits Windows PowerShell XML help files for all command types, including cmdlets, functions, workflows, and CIM commands.

The PowerShell HelpWriter XML editor is a complete XML editor—not just a read-only viewer.

The installation is straight forward.

PoSh-HelpWriter15-01

Accept the Terms and License Agreement

PoSh-HelpWriter15-02

You can select Custom and choose what feature you would like to install.

PoSh-HelpWriter15-03

PoSh-HelpWriter15-04

Hit Install

PoSh-HelpWriter15-05

The installation should be complete pretty quickly.

PoSh-HelpWriter15-06

Launch PowerShell HelpWriter

PoSh-HelpWriter15-11

Next, select new and choose to create New Help File from existing module or a new Help file. I’m going to use an existing module that already has comment based help.

PoSh-HelpWriter15-07

I will choose of course Hyper-V Winking smile and hit Export

PoSh-HelpWriter15-08

PoSh-HelpWriter15-09

Here you go the full Hyper-V module help files and examples has been exported, you can start creating your own help files or editing the existing XML help files! 

PoSh-HelpWriter15-10

Key Features
  • Generate help files from modules

    No need to start from scratch. PowerShell HelpWriter analyzes your module and generates starter help files that match the cmdlet code.

  • Focus on examples

    The PowerShell HelpWriter designer features an environment especially designed for writing examples with an editable prompt and monospace font for formatting output.

  • Get the details right

    PowerShell HelpWriter makes it easy to include even detailed information for advanced readers.

  • Get-Help!

    You can test your help files as you work, validate them, and run them in Windows PowerShell.

  • Edit in XML

    Whenever you need it, you can view or edit the help file in the built-in XML editor. The PowerShell HelpWriter XML editor is a complete XML editor—not just a read-only viewer.

  • Complete Help Editor UI

    Features a dynamic editor that guides you through the process of writing complete and accurate help topics for all of your commands.

  • Help Matches the Code

    PowerShell Help Writer generates starter help topic from the code in any command of any type, including individual commands and commands in a module. No need to figure out the cmdlet attribute or parameter attribute values, inputs or outputs. And, the help always matches the code.

  • Create help files from scratch

    Use the PowerShell Help Writer editor to create help from scratch for new or existing commands. Write help for a command even before the command code is written and it as a code specification.

  • Edit existing help files

    Edit existing help files in the PowerShell Help Writer editor UI or as XML. Add or delete parameters, including dynamic parameters.

  • Convert comment-based-help to PSMAML

    Generates starter help from existing help in your new PSMAML files, including comment-based-help for functions.

  • Write excellent examples

    Displays a custom UI for writing examples with a monospace font.

  • Validate PSMAML Files

    All help files conform to the PSMAML schema for Windows PowerShell help files. Use the Validate Help Schema feature to validate any file.

  • Edit as XML

    Edit any XML file in the color-coded XML editor with XML node navigation and PrimalSense code completion.

  • Run it at the command line!

    Try Write-HWHelp, a cmdlet that opens PowerShell Help Writer with new or existing help files for the commands that you specify.
    PS C:\> Write-HWHelp -Command MyFunction -File “C:\MyHelp.psm1-Help.xml”
    PS C:\> Get-Command -Module NewModule | Write-HWHelp -File NewModule.dll-help.xml

So stay focus on your tool content and let PowerShell Help Writer 2015 worry about the XML for you.

I believe this is going to be a great asset for PowerShell professionals looking to create a complete help documentation for their Tools.

You can download a 45-day evaluation copy from their online store.

Enjoy your day!

Cheers,
/Charbel

About Charbel Nemnom 310 Articles
Charbel Nemnom is a Microsoft Cloud Consultant and Technical Evangelist, totally fan of the latest's IT platform solutions, accomplished hands-on technical professional with over 15 years of broad IT Infrastructure experience serving on and guiding technical teams to optimize performance of mission-critical enterprise systems. Excellent communicator adept at identifying business needs and bridging the gap between functional groups and technology to foster targeted and innovative IT project development. Well respected by peers through demonstrating passion for technology and performance improvement. Extensive practical knowledge of complex systems builds, network design and virtualization.

Be the first to comment

Leave a Reply