User Documentation
Providing appropriate user documentation is one of the most important aspects
of software development as it will determine the level of acceptance of the user
to the software. It is imperative that the Documentation Specialists
familiarize themselves with the user, the user's environment, and the software,
in order to provide the user with as much help as possible to utilize the
software as effectively and quickly as possible.
User documentation can occur in one of several ways. Two possible ways,
through a User Manual and through on-line help, are provided here. Other
methods such as through a quick reference card are also possible.
Sometimes a tutorial can also be useful for properly training the users.
Note: The form and type of user documentation that is provided
should be determined in consultation with the client.
The User Documentation Specialists need to:
- Determine the different types of users who will be using the system
- Meet with the different types of users and ascertain their computer skill
level and acceptance of the software
- Become familiar with the user's environment
- Work with the Requirements Analysts to ensure the requirements address the
user's needs
- Determine the tasks the users need to perform currently and with the
software
- Address what user documentation is needed
- Write the user documentation agreed upon
- Assist the Testers with the installation and testing of the software at
the user's site
- Provide training so that the user learns how to use the software
The following templates should be used if a User Manual and/or on-line
help is provided, unless the client specifies differently (and the project
supervisor is notified):
If any section is not applicable, leave the section
and replace the contents with "Not Applicable" along with the reason the section
is not applicable.
Submitter: Lead User Documentation Specialist
Document File Name:
- UserDoc<ProjectName>UserManMMDDYYYY.html
- UserDoc<ProjectName>OnLineHelpMMDDYYYY.html
- where MMDDYYYY should be the date of submission to the project web site.