PowerShell HelpWriter

The first professionally designed environment for writing and editing Windows PowerShell help files.

PowerShell HelpWriter is the premier editor for Windows PowerShell XML help files. Create and edit help files for all command types, including cmdlets, functions, workflows, and CIM commands. Focus on your content and let PowerShell HelpWriter worry about the XML.

PowerShell HelpWriter analyzes your module and generates starter help files that match the cmdlet code and converts existing comment-based help.

Exports your PowerShell help to HTML or markdown at the press of a button.

Write help for a module before the code is written as a code specification. Once the help is written, use PowerShell Studio’s New Module from Help File feature to automatically generate the module’s code.

Generate help files for modules.

Create and edit about topics.

Real-time Spell checking.

Create and design module help from scratch.

Fully-featured editor helps you write accurate and complete help topics.

Edit help files using the designer or directly using the XML editor.

Supports all command types: cmdlets, functions, workflows, CIM commands.

Converts comment-based help to PSMAML files.

Generates starter help for any command or all commands in a module.

Export help to Markdown or HTML.

Refresh the content to reflect changes in the module.

Prevent loss of work with the File Recovery feature.

Key Features

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.

Manage module help files

Use a module project to manage and edit multiple help-xml and about help files. Refresh the module’s help content with a press of a button.

Help Matches the Code

PowerShell HelpWriter generates starter help topics 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.

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.

Design before coding

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.

Real-time Spell Checking

PowerShell HelpWriter provides real-time spell checking as you write.

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.

Create help files from scratch

Use the PowerShell HelpWriter editor to create help from scratch for new or existing modules.

Markdown and HTML Export

Export cmdlet help and about topics to markdown or HTML.

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. PowerShell HelpWriter will autocorrect common structural issues in order to comply with the MAML help schema.

Request Quote

Evaluation

LOGON is a pan-asian company operating in China, Hong Kong (HK), India, Singapore, Malaysia, Indonesia, Vietnam, Philippines and Thailand. LOGON has local dedicated trained product specialists in Hong Kong, Guangzhou, Kuala Lumpur, Mumbai and Bangalore. LOGON acts both as value added reseller and sole distributor for award winning software solutions. Customers can buy new licenses, purchase upgrades and renewals from any of our local offices. Contact us for first line support during evaluations, PoCs. We offer best practices consulting services and classroom & online training. Check our site for latest offers, special discounts, bundle deals, etc..