With the groundwork out of the way, this concluding partexamines the standard components of a technical reference manual,explaining what goes into each section and why. It also discusses theprocess by which such a manual should be reviewed and vetted prior todelivery to a customer.
With all of this behind you, you will finally be ready to release themanual. The following frills will complete the package:
1. Cover page
The name of the software should be written in accordance with thebrand decided.
The version number of the software should be clearly stated.
The name of the developer with address and contact numbers.
2. Table of contents
The topics should be linked to the matter inside.
3. Notifications for proprietorship and confidentiality
4. Headers and footers
Headers could include the project name and version number of thedocument.
Footers can have the page numbers and a short confidentialitynotice.
It might also be a good idea to include a feedback form as the lastpage, as your users will probably get back to you with suggestions. Thiswill be especially useful if there is a second phase of development forthe software.
And that's about it. Publish your manual (either on paper or as anelectronic PDF) to your customer, and relax - you've earned it!
Note: Examples are illustrative only, and are not meant for a productionenvironment. Melonfire provides no warranties or support for the sourcecode described in this article. YMMV!