Writing A Software Technical Reference Manual (part 2) - Sealed With A Kiss (
Page 6 of 6 )
With all of this behind you, you will finally be ready to release the
manual. The following frills will complete the package:
1. Cover page
- The name of the software should be written in accordance with the
brand 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 the
document.
Footers can have the page numbers and a short confidentiality
notice.
It might also be a good idea to include a feedback form as the last
page, as your users will probably get back to you with suggestions. This
will be especially useful if there is a second phase of development for
the software.
And that's about it. Publish your manual (either on paper or as an
electronic PDF) to your customer, and relax - you've earned it!
Note: Examples are illustrative only, and are not meant for a production
environment. Melonfire provides no warranties or support for the source
code described in this article. YMMV!
