Docs-US_DOD-STD2167A

 view release on metacpan or  search on metacpan

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

are initially referenced in the specification..

=head2 3.2.9 Tables.

A table is an arrangement of data in lines and columns.
It shall be used when data can thus be presented more clearly
than text. Elaborate or complicated tables shall be avoided. References
in the text shall be sufficiently detailed to make the purpose
of the table clear, and the table shall be restricted to data
pertinent to the associated text..

=head2 3.2.9.1 Location of tables in specifications.

A table shall be placed following, or within, the
paragraph containing a reference to it. If space does not permit,
a table shall be placed at the beginning of the succeeding page,
or if extensive, on a separate page. If tables are numerous and
their location, as indicated above, would interfere with correct
sequencing of paragraphs and cause difficulty in understanding
or interpretation, they may be placed in numerical sequence at
the end of the specification before any appendix or index. .


=head2 3.2.9.2 Preparation of tables.

The tables shall be numbered consecutively with Roman
numerals in the order in which they are initially referenced in
the specification. The number and title shall be placed above
the table. The contents of a table shall be organized and arranged
to show clearly the significance and relationship of the data.
Data included in the text shall not be repeated in the table.
Tables shall be boxed in and ruled. When a table is of such width
as to make it impracticable to place it in normal position on
the page, it shall be rotated counterclockwise 90 degrees..

=head2 3.2.10 Foldouts.

Foldouts shall be avoided except where required for
legibility. Large tables or figures may be broken out so that
they may be printed on facing pages. Where foldouts are required,
they should be grouped in one place, preferably at the end of
the specification (in the same location as figures) and suitable
reference to their location shall be included in the text. .

=head2 3.2.11 Footnotes.

=head2 3.2.11.1 Footnotes to text.

Footnotes to the text shall be avoided if possible.
Their purpose is to convey additional information that is not
properly a part of the text. A footnote to the text shall be placed
at the bottom of the page containing the reference to it..

=head2 3.2.11.2 Footnotes to tables and figures.

Footnotes
to a table or figure shall be placed below the table or figure.
The footnotes may contain mandatory information that cannot be
presented as data within a table. Footnotes shall be numbered
separately for each table. Where numerals will lead to ambiguity
(for example in connection with a chemical formula), superior
letters, asterisks, daggers, and other symbols may be used..

=head2 3.2.12 Contractual and administrative requirements.

A specification shall not include contractual requirements which
are properly a part of the contract; such as cost, time of delivery,
instructions on reworking or resubmitting rejected items or lots
method of payment, liquidated damages, provision for configuration
items damaged or destroyed in tests, etc. Contractual, administrative,
and warranty provisions such as those covered in general provisions
of contracts, shall not be made part of the requirements in the
specification. Contractual and administrative provisions not covered
in the general provisions, but considered essential for procurement,
may be indicated as 'ordering data' or 'features
to be included in bids or in contract' in Section 6. This
provision shall be exercised with caution and limited to essential
matters. .

=head2 3.2.13 Definitions in specifications.

The inclusion
of a definition can be avoided if requirements are properly stated.
When the meaning of one or more terms must be established in the
specification, definitions shall be placed in the text. However,
it is often clearer to list one or more definitions in Section
6, especially where the terms are used in many places throughout
the specification. When this is done, a parenthetical reference
to the applicable paragraph in Section 6 shall follow the terms
to indicate the existence of a definition..

=head2 3.2.14 References to other documents.

Referencing
is the approved method for including requirements in specifications
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 specification,
and are current and available. Care shall be taken in writing
the specification to indicate in a positive manner the extent
to which a referenced document is applicable. The specification
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..

=head2 3.2.14.1 Limitation on references. 

A specification
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 specification
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 specification
shall be defined in Section 3, 4, or 5, as appropriate. The extent

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

etc.

(Copies of specifications, standards, drawings, and
publications required by suppliers in connection with specified
procurement functions should be obtained from the contracting
agency or as directed by the contracting officer).

=head2 4.2.3.2. Non-Government documents.

Non-Government
documents shall be listed in appropriate order under a paragraph
similar to one of the following subparagraphs:

Example 1:

2.2 Non-Government documents. The following documents
form a part of this specification to the extent specified herein.
Unless otherwise indicated the issue in effect on date of invitation
for bids or request for proposal shall apply.

Example 2:

2.2 Non-Government documents. The following documents
of the exact issue shown form a part of this specification to
the extent specified herein. In the event of conflict between
the documents referenced herein and the contents of this specification,
the contents of the specification shall be considered a superseding
requirement.

Non-Government documents shall be listed in the following
order:

SPECIFICATIONS:

STANDARDS:

DRAWINGS:

OTHER PUBLICATIONS:

(list source for all documents not available through
normal Government stocking activities.)

The following source paragraph shall be placed at
the bottom of the list when applicable.

'Technical society and technical association
specifications and standards are generally available for reference
from libraries. They are also distributed among technical groups
and using Federal agencies.'



=head2 4.3 Section 3 - REQUIREMENTS.

The essential requirements
and descriptions that apply to performance, design, reliability,
personnel subsystems, etc. of the configuration item, material
or process covered by the specification shall be stated in this
section. These requirements and descriptions shall define as applicable,
the character or quality of the materials, formula, design, construction,
performance, reliability, transportability, and product characteristics,
chemical, electrical, and physical requirements, dimensions, weight,
color, nameplates, product marking, workmanship, etc. This section
is intended to indicate, as definitively as practicable, the minimum
requirements that a configuration item, material or process must
meet to be acceptable. The Requirements section shall be so written
that compliance with all requirements will assure the suitability
of the configuration item, material or process for its intended
purpose, and non-compliance with any requirement will indicate
unsuitability for the intended purpose. Only those requirements
shall be specified that are necessary and practicably attainable.

=over 4

=item 1

Section 3 of a general specification shall
contain all requirements that are common to a family of systems,
configurations items, materials or processes. When detail specifications
are to be prepared to supplement the general specification to
fully define an individual configuration item, etc., the following
paragraph shall be included in Section 3 of the general specification:

3.x.x Detail Specification. Requirements for individual
(insert the proper term from among the following) parts, configuration
items, materials, process, systems shall be as specified herein
and in accordance with the applicable detail specification.

=item 2

Section 3 of a detail specification shall
contain the requirements only for the particular system, configuration
item, material or process covered by that specification. However,
if the specification does cover more than one type, class, grade,
etc., it should first specify the general requirements for all
types, classes, grades, etc. The differentiating requirements
may then be specified for the individual types, classes, grades,
etc., in the proper sequence. In general, each requirement shall
be covered in a separate paragraph; and where one requirement
differs for the various types, classes, grades, etc., a separate
paragraph immediately following the general requirements shall
be devoted to each type, class, grade, etc. The various detailed
requirements shall be contained in appropriate subparagraphs.
Where it is necessary to include additional data, descriptive
and appropriate headings shall be used and assigned in logical
order.

=item 3

Section 3 of system or development specifications
(Type A or B) shall set forth requirements in terms or performance,
reliability, design constraints, functional interfaces, etc.,
that are necessary to assure a practical and reasonable development
effort. Development specifications may include design goals in
addition to minimum requirements, but in such case, goals and
requirements shall be clearly identified to avoid confusion. Only
essential design constraints shall be included as requirements,
such as restriction of use of certain materials due to toxicity,
dimensional or functional restrictions to assure compatibility
with associated equipments, etc.

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

Reliability requirements shall
be stated numerically with confidence levels, if appropriate,
in terms of mission success or hardware mean time between failures.
Initially, reliability may be stated as a goal and a lower minimum
acceptable requirement. During contract definition, or equivalent
period, realistic requirements shall be determined and incorporated
in the specification with requirements for demonstration. Reliability
requirements shall never be stated as a goal in Type C (product)

specifications.

=head2 4.3.2.4 Maintainability. 

Numerical maintainability
requirements shall be stated in such terms as mean-time-to- repair
(MTTR) or maintenance man-hours per flight/operational hour. Determination
of realistic requirements shall be made as discussed in 4.3.2.3
for reliability. Qualitative requirements for accessibility, modular
construction, test points, and other design requirements may be
specified as required.

=head2 4.3.2.5 Environmental conditions. 


Environments that
the system or equipment is expected to experience in shipment,
storage, service, and use shall be specified. Where applicable,
it shall be specified whether the equipment will be required to
meet or be protected against specified environmental conditions.
Subparagraphs shall be included as necessary to cover environmental
conditions such as: climate, shock, vibration, noise, noxious
gases, etc.

=head2 4.3.2.6 Transportability.

Any special requirements
for transportability and materials handling shall be specified
under this heading.

=head2 4.3.3 Design and construction.

Minimum or essential
requirements that are not controlled by performance characteristics,
interface requirements, or referenced documents shall be specified.
They shall include appropriate design standards, requirements
governing the use or selection of materials, parts and processes,
interchangeability requirements, safety requirements, and the
like.

=head2 4.3.3.1 Materials. 

Requirements for materials to
be used in the item or service covered by the specification shall
be stated under this heading, except where it is more practicable
to include the information in other paragraphs. Requirements of
a general nature should be first, followed by specific requirements
for the material. Definitive documents shall be referenced for
the material when such documents cover materials of the required
quality.

=head2 4.3.3.1.1 Toxic products and formulations.

Specifications
requiring or permitting toxic products and formulations shall
demand compliance with the requirements of the applicable regulations
promulgated by the appropriate Federal regulatory agency or the
official compendia governing such products and formulations.

=head2 4.3.3.2. Electromagnetic radiation.

Where applicable,
requirements pertaining to electromagnetic radiation shall be
stated in terms of the environment which the item must accept
and the environment which it generates.

=head2 4.3.3.3. Nameplates or product markings.

The nameplate
or markings in some cases may be the only means of identification
of a product after delivery. Such identification is important
from the standpoint of stock, replacements, and repair parts.
All requirements pertaining to nameplates or markings shall be
placed under this, or other appropriate heading, referencing applicable
specifications (e.g., MIL-STD-130), drawings, or standards.

=head2 4.3.3.4 Workmanship. 

Where applicable, reference
to workmanship shall be stated and shall include the necessary
requirements relative to the standard of workmanship desired,
uniformity, freedom from defects, and general appearance of the
finished product. This paragraph is intended to indicate as definitively
as practicable the standard of workmanship quality that the product
must meet to be acceptable. The requirements shall be so worded
as to provide a logical basis for rejection in those cases where
workmanship is such that the time is unsuitable for the purpose
intended. Generally, no definite tests other than visual examination
of workmanship will be applicable to the requirements of this
paragraph.

=head2 4.3.3.5 Interchangeability.

This paragraph shall
specify the requirements for the level at which components shall
be interchangeable or replaceable. Entries in this paragraph are
for the purpose of establishing a condition of design, and are
not to define the conditions of interchangeability that are required
by the assignment of a part number.

=head2 4.3.3.6 Safety.

This paragraph shall specify requirements
to preclude or limit hazard to personnel, equipment, or both.
To the extent practicable, these requirements shall be imposed
by citing established and recognized standards. Limiting safety
characteristics peculiar to the item due to hazards in assembly,
disassembly, test, transport, storage, operation or maintenance
shall be stated when covered neither by standard industrial or
service practices nor the system specification. 'Fail-safe'
and emergency operating restrictions shall be included when applicable.
These shall include interlocks and emergency and standby circuits
required to either prevent injury or provide for recovery of the
item in the event of failure.

=head2 4.3.3.7 Human engineering. 

Human engineering requirements

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

=head2 4.3.9 Qualification.

Qualification, as used in this
Standard, refers to the verification or validation of item performance
in a specific application. This qualification results from design
review, test data review, and configuration audits. Where performance
qualification of a design or an end configuration item (including
its components) is required, either on a one-time basis or a periodic
basis, to achieve design approval, proof of producibility, assessment
of production or other reason, provisions for such qualification
testing shall be stated in this paragraph. Requirements shall
be included which state the conditions for testing, the time (program
phase) of testing, period of testing, number of units to be tested,
and other requirements relating to qualification or requalification.

Qualification, as used in Defense Standardization
Manual 4120.3-M, refers to the testing or review of test data
to judge configuration items from various sources as being suitable
for general application, and is intended to lead to the establishment
of a Qualified Products List (QPL). Therefore, this type of qualification
is subject to the provisions of Manual 4120.3-M and is not within
the scope of this Standard.


=head2 4.3.10 Standard sample.

A standard sample is one
considered essential to supplement or illustrate certain requirements
of the specification. Use of standard samples should be kept to
a minimum, since their use can create problems in determining
the acceptability of HWCIs subsequently produced. Adequate inspection
requires that all requirements be made available such as the approved
tolerances of dimensions, performance, etc. A standard sample
does not provide all this information but must be supported by
specification requirements and drawings. The use of the standard
sample shall be limited to the illustration of qualities and characteristics
that cannot be readily described because detailed test procedures
or design data are not available, or because certain qualities
and characteristics cannot be definitely expressed, such as the
texture of fur, the color of cloth, or the grain of wood. Further,
the specification should state the specific characteristics and
the degree to which these characteristics are to be observed in
the standard sample. When a standard sample is to be furnished,
it shall be so stated in Section 3. Means of obtaining or viewing
standard samples shall be specified in Section 6.

=head2 4.3.11 Preproduction sample, periodic production
sample, pilot, or pilot lot.

Where it is essential that a preproduction
or periodic production sample, a pilot model, or a pilot lot be
tested for design approval prior to or during regular production
on a contract or order, the requirements shall be specified in
this section under the appropriate paragraph identification.

=head2 4.4. Section 4 - QUALITY ASSURANCE PROVISIONS.


For software, this section shall be titled Qualification Requirements
and shall specify the qualification requirements, including methods,
levels of testing, tools, facilities, test formulas, algorithms,
and acceptance tolerance limits required to show that the requirements
stated in Section 3 and 5 have been met. The Software Requirements
and Interface Requirements Specification Data Item Descriptions

contain further information for specifying qualification requirements
(See 6.2). For software embedded in firmware devices, the application
of quality assurance provisions or requirements depends on whether
the software is designated as a CSCI or part of an HWCI. When
the software is designated as a CSCI, Qualification Requirements
apply, but when designated as part of an HWCI, Quality Assurance
Provisions apply. For hardware, this section shall include all
of the examinations and tests (by reference where applicable)
to be performed in order to ascertain that the product, material
or process to be developed or offered for acceptance conforms
to the requirements in Sections 3 and 5 of the specification.
Section 4 shall be arranged in an orderly sequence which will
indicate clearly which inspections (examinations and tests) apply
directly to the process, material, HWCIs, or lots of HWCIs that
were developed or produced and which apply to requirements such
as evaluation, qualification (See 4.3.9), preproduction sample,
pilot model, or pilot lot. The order of presentation of Section
4 material shall, insofar as practicable, follow the order of
requirements as presented in Section 3 of the specification, or
alternatively in the most logical order of conducting the examinations
and tests listed.

=head2 4.4.1 General.

Where applicable, the general test
and inspection philosophy shall be described with a statement
of responsibility for inspection, classification of examinations
and tests, sampling, lot formation, and other information pertinent
to the quality assurance provisions but not directly associated
with a specific test or examination.

=head2 4.4.1.1 Responsibility for inspection.

The DOD concept
of quality assurance places primary responsibility for quality
assurance of delivered products, materials or services on the
supplier who is responsible for offering to the contracting agency
only those products, materials or services that conform to all
specified requirements. In system specifications, however, where
assembly of the system/subsystem is at a Government facility or
on a Government-owned vessel involving Government-furnished property
and personnel, responsibility for the conduct of tests will probably
be split between the contracting agency and the contractor. Accordingly,
the supplier's responsibility for inspection shall be clearly
stated and the contracting agency's role, either as a partner
or monitor, shall be specified. A typical statement of responsibility
is as follows:

=head2 4.1.1 Responsibility for inspection.

Unless otherwise
specified in the contract or order, the supplier is responsible
for the performance of all inspection requirements as specified
herein. Except as otherwise specified, the supplier may utilize
his own facilities or any commercial laboratory acceptable to
the contracting agency. The contracting agency reserves the right

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

Examples are:

=over 4

=item 1

Time (e.g., mean and maximum downtime, reaction
time, turnaround time, mean and maximum time to repair, mean time
between maintenance actions).

=item 2

Rate (e.g., maintenance manhours per flying
hour, maintenance manhours per specific maintenance action, operational
ready rate, maintenance hours per operating hours, frequency of
preventive maintenance).

=item 3

Maintenance complexity (e.g., number of people
and skill levels, variety of support equipment).

=back

=head2 20.3.2.5 Paragraph 3.2.5, Environmental conditions.

This paragraph shall include both induced and natural environmental
conditions expected to be encountered by this prime item during
storage, shipment, and operation. It shall include factors such
as climate, shock, vibration, noise, and noxious gases.

=head2 20.3.2.6 Paragraph 3.2.6, Transportability. 

This paragraph shall include requirements for transportability which
are common to all components to permit employment and logistic
support. All components that, due to operational characteristics,
will be unsuitable for normal transportation methods shall be
identified.

=head2 20.3.3 Paragraph 3.3, Design and construction. 

This paragraph shall specify minimum prime item design and construction
standards which have general applicability and are applicable
to major classes of equipment (e.g., aerospace vehicle equipment
and support equipment) or are applicable to particular design
standards. To the maximum extent possible, these requirements
shall be specified by reference to the established military standards
and specifications. In addition, this paragraph shall specify
criteria for the selection and imposition of Federal, military,
and contractor specifications and standards.

=head2 20.3.3.1 Paragraph 3.3.1, Materials, processes, and
parts.

This paragraph shall specify those prime item-peculiar
requirements governing use of materials, parts, and processes
to be used in the design of the prime item. It shall also contain
specifications as necessary for particular materials and processes
to be utilized in the design of the prime item. Special attention
shall be directed to prevent unnecessary use of strategic or critical
materials, or toxic products and formulation. A strategic and
critical materials list can be obtained from the contracting agency.
In addition, requirements for the use of standard and commercial
parts for which qualified products lists have been established
shall be specified in this paragraph.

=head2 20.3.3.2 Paragraph 3.3.2, Electromagnetic radiation.

This paragraph shall contain requirements pertaining to electromagnetic
radiation. It shall cover both the environment in which the prime
item operates as well as that which it generates.

=head2 20.3.3.3 Paragraph 3.3.3, Nameplates and product
marking.

This paragraph shall contain requirements for nameplates,
part marking, serial and lot number marking, and all other identifying
markings required for the prime item and its component parts.
Requirements shall usually be stated in general terms and reference
made to existing standards on the content and application of such
markings.


=head2 20.3.3.4 Paragraph 3.3.4, Workmanship.

This paragraph
shall contain workmanship requirements for development models
of equipments to be produced during development, including requirements
for manufacture by production techniques, if applicable.

=head2 20.3.3.5 Paragraph 3.3.5, Interchangeability.

This paragraph shall identify those components to be interchangeable
and replaceable. Entries in this paragraph are for the purpose
of establishing a condition of design, and are not to define the
conditions of interchangeability that are required by the assignment
of a part number.

=head2 20.3.3.6 Paragraph 3.3.6, Safety.

This paragraph
shall specify requirements to preclude or limit hazards to personnel
and equipment. To the extent practicable, these requirements shall
be imposed by citing established and recognized standards. For
prime items directly supporting a system, appropriate paragraphs
of the system specification shall be cited, such paragraphs being
amended on 'add' or 'delete' basis for applicability
to the prime item. Limiting safety characteristics peculiar to
the prime item due to hazards in assembly, disassembly, test,
transport, storage, operation or maintenance shall be stated when
covered neither by standard industrial or service practices nor
by the system specification. 'Fail-safe' and emergency
operating restrictions shall be included where applicable. These
shall include interlocks and emergency and standby circuits required
to either prevent injury or provide for recovery of the prime
item in the event of failure.

=head2 20.3.3.7 Paragraph 3.3.7, Human performance/human
engineering.

Human engineering requirements for the configuration