| Date | Version | Changes/Additions | Responsible Person |
For every modification to this document (including the first time it was handed in), an entry must be made in this field. This way, others reading the document can tell what modifications have been made, and when. Document modifications must be indicated within the document using some form of highlighting, such as change bars.
A listing of the contents of the user's manual.
A high-level overview of the original system, and the functionality you are adding. It should describe the project, as well as its purpose. Unlike the similar description you wrote in the requirements document, this overview is oriented towards describing how the system solves user problems, or, in the case of a game, provides a fun, satisfying gaming experience. Even though the reader is already pretty interested in your system if they're bothering to read the manual, you're still trying to perform a kind of soft-touch sell of the functionality.
The kind of computer, operating system, language runtime environment, etc. the user needs to run this program.
Definitions of important and specialized terms and acronyms that the user might need to understand to read the rest of the user's manual. This is likely a much smaller list of terms than you had in the requirements document, since this list only contains user-visible concepts.
How to install and run the software. Be very precise, and give exact command sequences.
A series of sections where you describe the operation of the project. Make sure you describe how to exit the program, and how to get additional help from within the program. In order to provide a meaningful description of your project's capability, it may be necessary to also describe how to use some features of the original program. Make sure the sections are numbered, since you'll need these section numbers for the traceability matrix.
| Requirement | User's Manual Section(s) | Comments |
| The section number of every requirement in the requirements document must be listed here, in order, even if there isn't a user's manual section that directly addresses it. We're intentionally looking for gaps. | List the sections of the user's manual that discuss the user interface for the functionality in the requirement. | Additional descriptive text that may help understand the mapping of requirement to user interface item, or lack thereof. Not every requirment needs a comment. |
Last modified: