view release on metacpan or  search on metacpan

lib/Docs/US_DOD/STD490A.pm  view on Meta::CPAN

The Software Design Description shall also describe
the detailed decomposition of high level software units to lower
level software units. The Software Design Description shall be
prepared by the contractor and shall be in accordance with the
format and content of the Software Design Description Data Item
Description (see 6.2)..

=head2 3.1.3.3.5.3 Data Base Design Description.

The Data Base Design Description describes one or
more data base(s) used by the CSCI. If there is more than one
data base, each data base may be described in a separate Data
Base Design Description. The Data Base Design Description(s) shall
be prepared by the contractor and shall be in accordance with
the format and content of the Data Base Design Description Data
Item Description (see 6.2)..

=head2 3.1.3.3.5.4 Interface Design Description.

The Interface Design Description provides the detailed
design of one or more CSCI interfaces. When Interface Requirements
Specifications have been prepared, associated Interface Design
Descriptions shall be prepared as well. The Interface Design Description
shall be prepared by the contractor and shall be in accordance
with the format and content of the Interface Design Description
Data Item Description (see 6.2). .

=head2 3.1.3.4 Type D - Process specifications. 

(See Appendix
XIV for outline of form.) This type of specification is applicable
to a service which is performed on a product or material. Examples
of processes are: heat treatment, welding, plating, packing, microfilming,
marking etc. Process specifications cover manufacturing techniques
which require a specific procedure in order that a satisfactory
result may be achieved. Where specific processes are essential
to fabrication or procurement of a product or material, a process
specification is the means of defining such specific processes.
Normally, a process specification applies to production but may
be prepared to control the development of a process..

=head2 3.1.3.5 Type E - Material specifications. 

(See Appendix
XV for outline of form.) This type of specification is applicable
to a raw material (chemical compound), mixtures (cleaning agents,
paints), or semi-fabricated material (electrical cable, copper
tubing) which are used in the fabrication of a product. Normally,
a material specification applies to production but may be prepared
to control the development of a material..

=head2 3.1.4 Two-part specifications.

Two-part specifications,
which combine both development (performance) and product fabrication
(detail design) specifications under a single specification number
as Part I and Part II respectively, may be selected as a contracting
agency option. This practice requires both parts for a complete
definition of both performance requirements and detailed design
requirements governing fabrication. Under this practice, the development
specification remains alive during the life of the HWCI as the
complete statement of performance requirements. Proposed design
changes must be evaluated against both the product fabrication
and the development parts of the specification. To emphasize the
fact that two parts exist, both parts shall be identified by the
same specification number and each part shall be further identified
as Part I or Part II, as appropriate. Two-part specifications
are not applicable when the product specification is a product
function specification or when it is a computer software specification..

=head2 3.2 Style, format and identification of
specifications.

=head2 3.2.1 General.

This section covers style, format, and general instructions
for preparing a specification. This includes material arrangement,
paragraphing, numbering, heading, and concluding material..

=head2 3.2.2 Sectional arrangement of specifications.

Specifications shall contain six numbered sections,
and appendixes as required, titled and numbered as shown below.

  1. SCOPE
  2. APPLICABLE DOCUMENTS
  3. REQUIREMENTS
  4. QUALIFICATION REQUIREMENTS (for software)
     or QUALITY ASSURANCE PROVISIONS (for hardware)
  5. PREPARATION FOR DELIVERY
  6. NOTES,
 10. APPENDIX

Subject matter shall be kept within the scope of
the sections so that the same kind of requirements or information
will always appear in the same section of every specification.
Except for appendixes, if there is no information pertinent to
a section, the following shall appear below the section heading:.

'This section is not applicable to this specification.'.

=head2 3.2.3 Language style.

The paramount consideration in a specification is
its technical essence, and this should be presented in language
free of vague and ambiguous terms and using the simplest words
and phrases that will convey the intended meaning. Inclusion of
essential information shall be complete, whether by direct statements
or references to other documents (See 3.1.4). Consistency in terminology
and organization of material will contribute to the specification's
clarity and usefulness. Sentences shall be as short and concise
as possible. Punctuation should aid in reading and prevent misreading.
Well-planned word order requires a minimum of punctuation. When
extensive punctuation is necessary for clarity, the sentence(s)
shall be rewritten. Sentences with compound clauses shall be converted
into short and concise sentences..

=head2 3.2.3.1 Capitalization, spelling, etc.

Except where DOD requirements differ, the United
States Government Printing Office Style Manual shall be used as