How to write aboute pages for module

This topic contains 1 reply, has 2 voices, and was last updated by Profile photo of Hermann Lüpfert Hermann Lüpfert 1 week, 1 day ago.

  • Author
    Posts
  • #58817
    Profile photo of OCram85
    OCram85
    Participant

    Is there a way to write about pages for own modules?

    I would like to explain basic concepts of my modules in about pages. I already documented my cmdlets with 'comment based help'

    Unfortunately I couldn't find any help how to create them. I looked at other modules like pester and noticed some *.help.txt files. Other modules provide xml files.

    Is there any advice or best practice how to create them?

  • #58820
    Profile photo of Hermann Lüpfert
    Hermann Lüpfert
    Participant

    There is a program called PowerShell HelpWriter for XML-basert helpfiles:
    https://www.sapien.com/software/powershell_helpwriter

You must be logged in to reply to this topic.