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 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!

DISCLAIMER: The content provided in this article is not warranted or guaranteed by Developer Shed, Inc. The content provided is intended for entertainment and/or educational purposes in order to introduce to the reader key ideas, concepts, and/or product reviews. As such it is incumbent upon the reader to employ real-world tactics for security and implementation of best practices. We are not liable for any negative consequences that may result from implementing any information covered in our articles or tutorials. If this is a hardware review, it is not recommended to open and/or modify your hardware.

Comments On: Writing A Software Technical Reference Manual (part 2)

>>> Be the FIRST to comment on this article!