Practices
  Home arrow Practices arrow Writing A User Manual (part 1)
Dev Shed Forums 
Administration  
Apache  
BrainDump  
DHTML  
Flash  
Java  
JavaScript  
Multimedia  
MySQL  
Oracle  
Perl  
PHP  
Practices  
Python  
Reviews  
Security  
Style-Sheets  
Web Services  
XML  
Zend  
Zope  
Forums Sitemap 
IBM® developerWorks 
Dedicated Servers 
E-Commerce Hosting 
Linux Web Hosting 
Managed Hosting 
Small Business Hosting 
Download TestComplete 
VPS Hosting 
Weekly Newsletter

 
Developer Updates  
Free Website Content 
 RSS  Articles
 RSS  Forums
 RSS  All Feeds
Write For Us Get Paid 
Request Media Kit
Contact Us 
Site Map 
Privacy Policy 
Support 
 USERNAME
 
 PASSWORD
 
 
  >>> SIGN UP!  
  Lost Password? 
PRACTICES

Writing A User Manual (part 1)
By: Deepa L, (c) Melonfire
  • Search For More Articles!
  • Disclaimer
  • Author Terms
  • Rating: 5 stars5 stars5 stars5 stars5 stars / 19
    2002-12-27

    Table of Contents:
  • Writing A User Manual (part 1)
  • Step By Step
  • Asking The Hard Questions
  • Making Friends And Influencing People
  • Being Conventional

  • Rate this Article: Poor Best 
      ADD THIS ARTICLE TO:
      Del.ici.ous Digg
      Blink Simpy
      Google Spurl
      Y! MyWeb Furl
    Email Me Similar Content When Posted
    Add Developer Shed Article Feed To Your Site
    Email Article To Friend
    Print Version Of Article
    PDF Version Of Article
     
     
    FaxWave - Free Trial.
     
    ADVERTISEMENT

    Stay one step ahead of the competition. Evaluate and give feedback on some of the hottest web development tools on the market today. Make your opinion heard! Click Here

    Writing A User Manual (part 1)
    (Page 1 of 5 )

    Depending on who you speak to, documentation is either the best part ofa software project...or the worst.

    Most developers wouldn't be caught dead writing a user manual - theymuch prefer spending their time building better, more efficientalgorithms. Their users, on the other hand, don't really care about thecode that powers a software application; they're more interested ingetting their work done quickly, with minimal errors.

    That's where support documentation, in the form of a user manual, comesin. Usually considered one of the least important deliverables, it isslowly coming of age, as software companies begin to realize the valueof high-quality documentation that answers most user questions andreduces after-sales support calls (and expense).

    Support documentation allows the user to use the delivered software withease and efficiency. Ideally, it comprises:
    1. Interface text: The labels on interface elements like menu items,fields, instructions, confirmations, error messages et al.
    2. Application messages: Operational error messages and warnings.
    3. Online documentation: Online help, tutorial and searchable helppages.
    4. Print documentation: User manual and technical reference manual.
    These, in totem, are the user's support system for usage of thesoftware.

    This article focuses on the user manual, explaining, from a technicalwriter's perspective, the process by which such a manual is developed,reviewed and delivered. I believe, though, that the process and planningtips are generic enough to apply to the other print documents, inaccordance with both their purpose and scope.

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


     

       

    PRACTICES ARTICLES

    - 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
    - Basic Ideas
    - Choosing the Right Team
    - Trees
    - Basic Array Searching in C++
    - Solving Problems with Recursion

     
    Accelerating Trading Partner Performance
     
    Competing on Analytics
     
    Cost Effective Scaling with Virtualization and Coyote Point Systems
     
    Five Checkpoints to Implementing IP Telephony
     
    Hosted Email Security: Staying Ahead of New Threats
     




    © 2003-2008 by Developer Shed. All rights reserved. DS Cluster 6 hosted by Hostway