|
Software
Development
Requirements
Homepage
Find A Topic
Software
Requirements:
FAQ
SET Newsletter
|
|
Draft User Documentation
Primary Responsibility: Software Developer
- What is User Documentation?
- Documentation Preview
- Common Problems
- Background Material
What is User Documentation?
User documentation includes both online help and descriptive material, as well as supplementary written material. User documentation may take the form of a User Guide or other information that accompanies the software. Supply all user documentation in electronic form, preferably utilizing Microsoft Word.
Documentation Preview
It is important to create drafts of the user documentation early in the software development process. A usable draft should be available at the beta testing stage, in order to get early user feedback.
EPRI Corporate Software Quality reviews the current draft of the user documentation before the software is beta tested with users. While the user documentation will not be complete at this point, it needs to include at a minimum:
- Installation instructions and system requirements
- General description of principal features and functions
- Solved examples that users can follow (if possible). Please see Solved Example Problems & Tutorial Checklist for more background.
- The Copyright, Disclaimer, and Ordering Information statements required for all EPRI publications. See EPRI Technical Publishing web pages for required text.
Common Problems
- Documentation is not included in the software test plans.
- Documentation does not match actual software (for example, screen shots in manual do not match user's screen).
- Features of the user interface (such as menu choices) are not documented or described.
Background Material
Return to top of the page 
|
|
|
