Home arrow Practices arrow Page 5 - Writing A User Manual (part 2)

Putting The Package Together - Practices

In this concluding article, take a look at a sample table ofcontents for a user manual, understand the importance of having yourwork reviewed by peers, and find out how to handle document versionmanagement.

TABLE OF CONTENTS:
  1. Writing A User Manual (part 2)
  2. Looking For Improvement
  3. Cheat Sheet
  4. Version Control
  5. Putting The Package Together
By: Deepa L, (c) Melonfire
Rating: starstarstarstarstar / 20
January 03, 2003

print this article
SEARCH DEV SHED

TOOLS YOU CAN USE

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

 
 
>>> More Practices Articles          >>> More By Deepa L, (c) Melonfire
 

blog comments powered by Disqus
escort Bursa Bursa escort Antalya eskort
   

PRACTICES ARTICLES

- Calculating Development Project Costs
- More Techniques for Finding Things
- Finding Things
- Finishing the System`s Outlines
- The System in So Many Words
- Basic Data Types and Calculations
- What`s the Address? Pointers
- Design with ArgoUML
- Pragmatic Guidelines: Diagrams That Work
- Five-Step UML: OOAD for Short Attention Span...
- Five-Step UML: OOAD for Short Attention Span...
- Introducing UML: Object-Oriented Analysis an...
- Class and Object Diagrams
- Class Relationships
- Classes

Developer Shed Affiliates

 


Dev Shed Tutorial Topics: