Successful Documentation Projects Part 2 of 3 Specifying
So youre responsible for managing a documentation project. You know who your audience is, what theyre trying to achieve, how the product enables them to achieve it, and what the audience requires of the help. Now its time to spec out your intentions.
NOTE: This is the second in a series of three articles outlining the key elements of a good user documentation process.
State your goals
Generically speaking, your goal statement should indicate that you hope to create a suite of documentation products that will satisfy audience requirements. Specifically, youll have a number of sub-goals. (TIP: It may help to remember that the goals you set here will need to be used to measure the success of your product through your own in-house testing as well as through evaluative user research.) Such sub-goals may include:
Ease of use
Accessibility
Helpfulness
Accuracy
Relevance
Comprehensiveness
Adherence to style guidelines
Correct spelling and punctuation
Write your Concept Specifications
Your goals set, you can start to...