Welcome back. We’ve been exploring how to use the Platyps module to create professional-looking documentation for your PowerShell module. We ended last time with an external XML file with help documentation for the PSAPICodepack module. As I showed you, the Playtps module does most of the work for you. You need to fill in the blanks with a good description and examples. But what happens when you need to revise the function? Maybe you need to add or delete a parameter? You don’t want to have to redo all your hard work. Here’s how the Platyps module handles this.

Update-MarkdownHelp

Let’s look at the Get-PSCodePackFile function. The function has this parameter.

Param(
    [Parameter(Mandatory, ValueFromPipeline,HelpMessage = "Specify the filepath and name.")]
    [Alias('FullName')]
    [ValidateNotNullOrEmpty()]
    [string]$Path
)