Download Manuals Development Guide

Transcript
Manuals Development Guide
June 2001
Purpose of Your Manual
In this part of your synopsis you are showing the program manager why there is a need for a User
Manual. You have just detailed who you are writing the manual for, now you can detail how it is going
to help them. What major topics do you cover? Is the manual to be in-depth and specific on all topics?
Why? Why not? What do you expect to do for the readers? In short, why is the manual being written?
Release Details
Is this a new manual for a new system or procedure? A new manual for an old system or existing
procedure? Are you making revisions to an old manual? Is the rewrite being done because of changes?
If so, what are the changes and how are you helping to ensure their impact is understood by the users?
Outline of Your Manual
You have just created the working outline. The reviewers should have a clear impression of the structure
your manual will have, including which topics will be covered, in what order and how they relate to each
other.
Having the Synopsis Reviewed
This is a crucial step in writing the user manual. It may be the first opportunity to see whether or the
writer and the Project Manager are thinking along the same lines. As a writer, you must show that your
structure is valid and will be of use to the potential users.
In some cases, members of the project team or an expert from the business area will work together with
you in creating the working outline. In such cases you can be fairly sure that your outline will be
accepted with only minor changes.
In other instances you will develop the working outline on your own, then present your complete
synopsis to the project team. Conducting a review at this early stage will ensure that all members of the
team (including you) know what the user manual will consist of. Sometimes a user or technical expert
will discover a point you overlooked. Or discussing why the manual is structured the way it is may give
you insight into previously unknown peculiarities of some of the business procedures.
Approval for the Synopsis
The review doesn't take long, and it is a very worthwhile exercise. Once the team has accepted your
synopsis you can begin writing the user manual, confident that you won't be presented with requests for
major structural changes later on. Someone will probably try to request major changes anyway but if you
have already got the team to review and approve your synopsis you can take a firm stand. (Unless, of
course, the request is prompted by a change in the way the system works, or how the users do their
business!)
Revising the Table of Contents
Once your synopsis has been reviewed you can make any revisions that are necessary. It is much easier
to reorganize your work and your way of thinking at this point than it is after pages of text have been
written around each part of the structure.
Page 28