System Engineering Management Plan
Section 3.12 - Model Text

3.12 Documentation control.

Documentation (i.e., not identified as configuration controlled items and therefore not subject to Formal* or Informal* project Configuration Control) produced during and for the project shall be held and change controlled by the Technical Authority Areas where they are produced and shall be identified and controlled in a similar manner to engineering drawings in accordance with AQAP 1 and 13 quality control system requirements.

Copies of the latest issue of these documents shall be held by the Technical Authorities documentation Librarian or similar position for the particular participating companies. Masters of all design and implementation documents however, shall be retained by the Configuration Management centre for the relevant participating company or supplier. Documents not identified for entry into the internal developmental configuration may be controlled by the Class II change procedures if requested by the acquirer or if directed by the individual participating companies or suppliers project management but shall not be identified within the change status reports.

The following table provides a types of documentation to technical authority responsibility matrix:

TABLE I. Documentation to technical authority matrix.

Type of documentation. Technical Authority.

This documentation shall be traceable, handled, stored, responsive to change of requirements and be consistent with the 'Configuration Management Plan' and/or SDP and/or any directly related and approved Configuration Management Plan/Document used for the project.

All documentation, specifications, files, etc., shall be classified, identified, stored and handled in accordance with the National Security Regulations. Documentation requirements of MIL-STD-490A, JSP 188, DOD-STD-2167/2168, MIL-STD-970/973, MIL-STD-483A, etc., shall be provided in a Documentation Standard* document for the project.

The documentation shall be reviewed and approved for adequacy by authorized personnel prior to issue; using procedures identified in the specific programme plan.

This control shall ensure that:

Changes to these documents shall be reviewed and approved by the same functions/organizations that performed the original review and approval unless specifically designated otherwise.

Where practicable, the nature of the change shall be identified in the document or the appropriate attachments.

All changes to documentation shall be in writing and processed in a manner which shall ensure prompt action. Marked-up copies of documents will not be acceptable. All changes will be documented by a formal change procedure and will be approved by the technical authority responsible for originating and revising the document.

A master list or equivalent document control procedure shall be established to identify the current revision of documents in order to preclude the use of non-applicable documents.

Documents shall be re-issued after a practical number of changes have been made.

Change Control of these documents shall be detailed in existing local procedures used by the areas of technical responsibility, i.e., departmental expositions, codes of practice, work instructions, etc., and will conform with AQAP-1/13 or ISO 9000 Quality Control/system requirements.

3.12.1 Documentation library.

A project library shall be established which shall contain the masters of all documentation referenced and prepared for the project to provide an historical and archive record. This shall include the contractual standards existent on the specific contract date. Documentation prepared and approved during the project life cycle shall be retained in this library until project termination or acquirer order.
A project file containing all the day-to-day records (memos, progress meeting minutes, faxes, letters) shall be established and maintained for the duration of the project within the documentation library.

3.12.2 Drawing library.

A drawing library shall be established and procedures for controlling the drawings, computer-aided design (CAD), computer-aided Manufacturing and instructions will reside within the drawing library.

3.12.3 Software development library.

A software development library

3.12.4 Documentation identification.

The system, subsystems, HWCIs, CSCIs and equipment will be identified by a Part or Identification Number (PIN) initially during the development phase and finally for production.


Back to Home page MANAGING STANDARDS Home page

Please send any beneficial comments or identification of errors using the following form to: kenr@wysywig.airtime.co.uk

Copyright © by Ken Rigby 1996,1997, 1998

Formal Configuration refers to documents produced for or authenticated by the procuring activity and formally change controlled by the methods contained in the CMP. Informal Configuration Control refers to the software documentation entered into the CSCI specific internal developmental configuration for example., Software design documents, Source Code listings.