|
|
This article is sample content outsourced to DocuMaker Communication Solutions. You can get similar content for your own website by outsourcing it here. |
Developing The User Manual
1. After successfully building and testing ONE feature of the publication, immediately create the end-user documentation for that feature in whatever interface you chose.
2. Using the help file templates provided in the iGui Cut and Paste Interface, create a new publication that will act as the help.pub and design a page to display the documentation for the feature you just completed. (Specific instructions are in the template.) Remember the page number and name of this publication.
3. Return to the main publication and edit the command that offers help for the feature you just completed to display the page number of the help.pub. (DC “Help.exe /K#” GRAPHICS+REDRAW for example). Don’t forget to compile the publications and test for their functionality as well.
4. Only after all of the help pages (belonging to their respective features) have been built should you begin work on the entire help file. This can be performed in the same manner that any publication is built right after the Debugging Process. When ready, refer to your User Manual Draft.
5. Until then, return to the next feature that remains to be developed and continue this cycle of development until all of the features are complete.
When finished, approximately 70% of your publication will be complete!
External Resources:
1. A Step-By-Step Approach to Writing User-Friendly Instructions
2. How To Write Usable User Documentation
3. How to Research, Write, Test, Edit & Produce a Software Manual
