Writing Help Files
Forum rules
DO NOT POST LICENSE NUMBERS, ACTIVATION KEYS OR ANY OTHER LICENSING INFORMATION IN THIS FORUM.
Only the original author and our tech personnel can reply to a topic that is created in this forum. If you find a topic that relates to an issue you are having, please create a new topic and reference the other in your post.
Any code longer than three lines should be added as code using the 'Select Code' dropdown menu or attached as a file.
DO NOT POST LICENSE NUMBERS, ACTIVATION KEYS OR ANY OTHER LICENSING INFORMATION IN THIS FORUM.
Only the original author and our tech personnel can reply to a topic that is created in this forum. If you find a topic that relates to an issue you are having, please create a new topic and reference the other in your post.
Any code longer than three lines should be added as code using the 'Select Code' dropdown menu or attached as a file.
Writing Help Files
How do most people write help files for PowerShell Studio application they create?
- mxtrinidad
- Posts: 399
- Last visit: Tue May 16, 2023 6:52 am
Re: Writing Help Files
I you're talking about help file(s) for individual functions and/or module functions, in PowerShell Studio you can use "Generate Comment Based Help". At the same time the "PowerShell HelpWriter" product can assist in writing the Help file(s) structures which could be imported into PowerShell Studio.
See following blog posts:
https://www.sapien.com/blog/2014/04/16/ ... ased-help/
https://www.sapien.com/blog/2014/06/05/ ... templates/
https://www.sapien.com/blog/2017/01/24/ ... ew-part-2/
See following blog posts:
https://www.sapien.com/blog/2014/04/16/ ... ased-help/
https://www.sapien.com/blog/2014/06/05/ ... templates/
https://www.sapien.com/blog/2017/01/24/ ... ew-part-2/
Re: Writing Help Files
More specifically user help files for the GUI to lead the user through the processes of the application and how to use the application I wrote using Powershell Studio.
I will check the links out.
Thanks
I will check the links out.
Thanks