This document identifies and describes the software as delivered, provides instructions to install the software, and also provides references on how to maintain the software. 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. Include identification numbers, version numbers, and release numbers as applicable.
Briefly state the purpose of the library system and the software to which this document applies. Describe the general nature of the system and software, summarize the history of system development; identify the project stakeholders (acquirer, users, developers, other parties); identify current and planned operating sites.
Summarize the purpose and contents of this document. Describe any privacy considerations associated with its use.
List the number, title, revision and date of all documents referenced in this document.
Include the following information, as applicable.
List all the physical media and associated documentation that make up the software version being released by identifying numbers, titles, abbreviations, dates, version numbers, and release numbers as applicable. Include privacy considerations and restrictions regarding duplication and license provisions.
List all computer files that make up the software version being released by identifying numbers, titles, abbreviations, dates, version numbers, and release numbers as applicable.
List all changes incorporated into the software since the previous version. Identify as applicable the problem reports and change notices for each change. This does not apply to the Initial Operating Capability version of the software.
Identify or reference all unique-to-site data contained in the software version.
List the number, title, revision and date of all documents pertinent to this software. This should include applicable requirements, design, test and user documents.
Provide the following information, as applicable.
a. Instructions for installing the software version. List any scripts used for installation.
b. Identification of other changes that have to be installed for this version to be used, including unique-to-site adaptation data not contained in the software version.
c. Privacy precautions relevant to the installation.
d. Procedures for determining whether the version has been installed properly.
e. A point of contact to be consulted if there are problems or questions with the installation.
Identify any possible problems or known errors with the software version at the time of release, and instructions for recognizing, avoiding, correcting or handling each error.
Refer to the procedures in the appropriate SDFs to change the source and create a new executable version of the software, including build procedures and make files as appropriate. Provide a point of contact to be consulted if there are problems or questions with the maintenance.
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.