Book Description
Technical Management - documentation Standard
The aim of the System/Software Documentation Standard (SDOS) is to identify and define the documentation (electronic and paper based) to be prepared by the projects.
The documentation style, format, and content is described or identified. Data is generally contractually identified as deliverable in the project specific SOW/CDRL in the form of Data Item Descriptions (DIDs).
Document style and format is a guide only and each developer is expected to conform to these requirements to produce a common suite of deliverable and non-deliverable documentation for all the projects.
This software documentation standard is to be used in the establishment of uniform practices for documentation preparation, interpretation, change, and revision, to ensure the inclusion of essential requirements. This standard will also aid in the use and analysis of the system/subsystem and its software documentation during the system/software life cycle of a project.
This document has been prepared to meet the system and software engineering management documentation requirements of ISO/IEC 15288, ISO/IEC 12207, MIL-STD-498, and SEI CMM 'best practices'.
Synopsis
Defines uniform practices for documentation preparation, interpretation, change, and revision to ensure inclusion of essential requirements The aim of the System/Software Documentation Standard (SDOS) is to identify and define the documentation (electronic and paper based) to be prepared by the projects. The documentation style, format, and content is described or identified. Data is generally contractually identified as deliverable in the project specific SOW/CDRL in the form of Data Item Descriptions (DIDs). Document style and format is a guide only and each developer is expected to conform to these requirements to produce a common suite of deliverable and non-deliverable documentation for all the projects. This software documentation standard is to be used in the establishment of uniform practices for documentation preparation, interpretation, change, and revision, to ensure the inclusion of essential requirements. This standard will also aid in the use and analysis of the system/subsystem and its software documentation during the system/software life cycle of a project. This document has been prepared to meet the system and software engineering management documentation requirements of ISO/IEC 15288, ISO/IEC 12207, MIL-STD-498, and SEI CMM "best practices". Systems Engineering Management Group (SEMG) will maintain this System/Software Documentation Standard. Users of this document may report deficiencies and or corrections using the format provided by the attached Document Change Request (DCR) form. SEMG shall configuration manage this data as part of the process improvements of the Software Project Planning.