A8b DI-IPSC-81443A.pdf

This is a Data Item Description (DID) for Software User Manual (SUM) documentation, identified as DI-IPSC-81443A, approved January 1, 2000. The DID establishes format and content requirements for software user manuals that provide hands-on instructions for installing and using Computer Software Configuration Items (CSCIs), software systems, or subsystems. The SUM applies to software with user interfaces requiring online user input or interpretation of displayed output and serves as an alternative to the Software Input/Output Manual (SIOM) and Software Center Operator Manual (SCOM).

The specification mandates that SUMs include comprehensive documentation organized into defined sections: scope (system identification, overview, document overview); referenced documents; software summary (application, inventory, environment, organization and operation, contingencies, security and privacy, assistance and problem reporting); access procedures (first-time user guidance, equipment familiarization, access control, installation and setup, session initiation, work cessation); processing reference guide (capabilities, conventions, procedures organized by function or menu, related processing, data backup, error recovery, messages, and quick-reference materials); and notes with glossaries and appendices as needed. The document must include title pages with identification numbers, versions, security markings, and distribution statements; tables of contents with page numbers; unique page numbering with document identifiers; and may employ automated techniques, alternate presentation styles (diagrams, tables, matrices), or substitute existing commercial documents that contain required information. Safety precautions marked as WARNING or CAUTION must be included where applicable.