Writing A User Manual (part 2) - Putting The Package Together

(Page 5 of 5 )

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. If you'd like to learn more about the technical writing process in general, here are some links you might find useful.

Developing documentation without a tech writer, at http://builder.com.com/article.jhtml?id=u00320020510gcn02.htm&vf=ra

The Seven Deadly Assumptions of Technical Communication, at http://www.williamrice.com/techcomm/sevenassumptions/7assump1.html#Assum ption1

Online Technical Writing - An Online Textbook at http://www.io.com/~hcexres/tcm1603/acchtml/acctoc.html

Happy writing!

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!

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 User Manual (part 2)

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