Documentation Standard
Section 1 - Model Text

1. SCOPE

1.1 Identification.

This Documentation Standard establishes the required standard for specifications, standards, plans, procedures, manuals, reports records, software development files and other data items to be prepared during the design, development of Systems, subsystems, Hardware Configuration Items (HWCIs, Computer Software Configuration Items (CSCIs).

1.2 Purpose.

The purpose of this standard is to detail requirements for the documentation to be prepared during the system life cycle of the identified project. The documents described shall be in accordance with the requirements specified in the SOW.
This documents meets the requirement of the contractual standards and provides a document strategy/standard for the documentation to be prepared and evaluated during the total system life cycle.

1.3 Document overview.

The 'Documentation Standard' consists of the following sections:

Section 1 identifies, sates the purpose and provides a brief summary;
Section 2 lists all referenced documents;
Section 3 provides a requirements definition of the document preparation, style, layout, format, etc., together with the procedures for documentation change, revision, and amendment;
Section 4 identifies the documentation groups to be prepared during the system and its development life cycles;
Section 5 briefly explains the purpose of each of the documents to be prepared and provides a brief summary overview;
Section 6 provides a list of definitions, abbreviations, and acronyms, and other non-mandatory information used throughout the document.

Appendixes to this document contain example texts for the document to be prepared during the system and its development life cycle (s). These shall be in accordance with data item descriptions identified by the referenced documents.
This document is a living document and as a result additions, deletions, and modifications will occur in accordance with continuous improvement initiatives. Therefore, to provide configuration identification this document will be identified with a project specific identification. This document shall also be released and change controlled using the methods defined in this document.

1.4 Relationship to other standards and plans.

The Documentation Standard shall be used in conjunction with the 'System Engineering Management plan' and 'Configuration Management Plan' to provide a fully integrated Project Management System in accordance with the 'Project (Program) Plan for the system.
This document provides a means of achieving the concept of minimum documentation required by Engineering Management (MIL-STD-499A) by identifying required plans, reports, and relevant data items.

LE FastCounter

Back to Home page MANAGING STANDARDS Home page