This manual provides the steps for running the software, describes the expected output(s), and describes the measures to be taken if errors occur. Use the outline below.
Provide the title(s), and abbreviations(s) (if applicable) of the software and the library system to which this manual applies.
State the purpose of the library system and the software to which this manual applies.
Summarize the purpose and contents of this document.
List the number, title, revision and date of all documents referenced in this document.
Briefly describe functions available to the user and describe the step-by-step procedures for accessing these functions.
Include the following information, as applicable:
a. Initialization. Describe any procedures needed to initialize the software. Identify any initialization options available to the user.
b. User Functions. Describe the functions available to the user. For each function describe:
1. User inputs including format, limitations, input method, etc.
2. Operational results
c. System Inputs. Describe the system inputs to the software that may occur while the software is in use and that may affect the interface with the user. Include format, frequency, allowable range, and units of measure, as applicable.
d. Termination. Describe how to terminate software operation and how the user determines that normal termination has occurred.
e. Restart. Describe the procedures for restarting the software.
Identify all error messages generated by the software, the meaning of each message, and the action to be taken when each message appears.
Include any general information that aids in the understanding of the document. All acronyms, abbreviations, and their meaning as used in this document should be listed.
Use appendixes for information that does not fit in the body of the document.