Documentation Standard
Section 3.1 - Model Text
Referencing is the approved method for including
requirements in documents where this eliminates the repetition
of requirements and tests that are adequately set forth elsewhere.
However, chain referencing should be avoided. References shall
be restricted to documents that are specifically and clearly applicable
to the document, and are current and available. Care shall be
taken in writing the document to indicate in a positive manner
the extent to which a referenced document is applicable. The document
shall also include any special details called for by the referenced
document. Reference to paragraph numbers in other documents shall
not be made. The reference shall be to a title, method number,
specifically identified requirement, or other definitive designation.
- A document shall not contain anything in conflict
with provisions in referenced documents unless it is desirable
to make special exceptions to such provisions, in which case the
specific provision to which exception is made shall be stipulated
or the application of a specific portion of the referenced document
shall be clearly defined.
It is not intended that other documents be made a part of a document
by reference unless the items, materials, tests, or other services
in the referenced documents are required in the quality and detail
which these documents are designed to produce. The applicability
of all referenced documents listed in Section 2 of a document
shall be defined in Section 3, 4, or 5, as appropriate.
The extent of applicability of referenced documents shall also
be specifically indicated. The whole of a referenced document
shall not be made applicable by reference unless all of its provisions
are clearly required.
When a document or portion of a document must be referenced, the
extent of its applicability as a requirement or as guidance only
shall be specifically indicated. When a document can be quoted
word for word; without adversely affecting the technical essence
or readability of the document (normally less than a page in content),
it may be quoted without referencing the document in the text
and section 2.
LE FastCounter
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