Program Documentation
Standard
Objective - to
specify a common standard for all documentation and identify the name and
content of the documentation to be prepared.
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 software project.
Documentation comes
in many forms, e.g., specifications, reports, files, descriptions, plans,
source code listings procedures, Change Requests, etc. and can be in electronic
or paper form. DIDs identified in the SOW/CDRL shall be used as the basic
requirement.
However, some minor
details may require standardizing (distribution statements, classification,
etc.). These will be contained in the document.
The Documentation
Standard defines the style, format, and the document revision/change process of
these documents.
It uses
MIL-STD-961D, MIL-STD-973, and MIL-STD-498 (DIDs) as the basis for the majority
of the documents. However, it shall reference the “<identify dictionary>
” for the basic definition of words, conventions, style, and abbreviations.
Note: Software
Design and software coding standards will be referenced in other documents.
This document is
available from AMAZON “Technical
Management - documentation
standard”
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 2000, 2001, 2002
All rights reserved.