Successful Documentation Projects Part 1 of 3 Understanding
The creation of user documentation is a big component of any software project. Unfortunately, its often undervalued and left to the last minute. But that doesnt mean it should be without a good management plan.
This is the first in a series of three articles outlining the key elements of a good user documentation process. Its kind of an ideal process; very few projects will be able to implement every step, and some will require additional steps. Nonetheless, it should provide you with a good foundation (especially if youre new to user documentation management).
Heres an overview of the three articles.
Article 1 (this article) Understand
Identify your scope
Familiarise yourself with the work environment
Familiarise yourself with the product
Identify the audience for the documentation
Specify perceived audience requirements
Roughly estimate doco project duration and resources
Research audience requirements
Article 2 Specify
State your goals
Write your concept specifications
Design some possible...