Result of choice

--::::::::::
--dod2167_rd.me
--::::::::::
PD2:

This subdirectory contains documents, DID templates, and tools
which support the development of DoD-STD-2167A (Military Standard
Defense System Software Development) deliverable documents as
specified in the DoD-STD-2167A Data Item Descriptors (DIDs).
--::::::::::
--did2167a.inc
--::::::::::
-- Templates for Documents and Manuals Specified in DoD-STD-2167A DIDs

-- These are global files used by all of the documents
-- and manuals. They can be set up once and reused
-- throughout all of the documents and manuals.
acronyms.ptf
header.ptf
overview.ptf

-- These are the documents and manuals required by the
-- DoD-STD-2167A DIDs. They are listed in numeric order of the DIDs.
sss.ptf
ssdd.ptf
sdd.ptf
vdd.ptf
stp.ptf
std.ptf
str.ptf
csom.ptf
sum.ptf
spm.ptf
fsm.ptf
crisd.ptf
srs.ptf
irs.ptf
idd.ptf
sps.ptf
sdp.ptf

-- The file PCR.PTF creates a standalone Problem/Change Report
-- The files PCRBODY.PTF and PCRDESC.PTF are used by PCR.PTF and
-- VDD.PTF, allowing PCRs to be easily incorporated into a VDD
-- or handled standalone.
pcr.ptf
pcrbody.ptf
pcrdesc.ptf
--::::::::::
--did2167a.pro
--::::::::::
-------- SIMTEL20 Ada Software Repository Prologue ------------
-- Unit name : DID2167A
-- Version : 2
-- Author : Richard Conn
-- : Ada Software Repository
-- DDN Address : rconn @ wsmr-simtel20.army.mil
-- Copyright :
-- Date created : 14 Sep 89
-- Release date : 15 May 90
-- Last update : 15 May 90
-- Machine/System Compiled/Run on : N/A
---------------------------------------------------------------
-- Keywords : DoD-STD-2167A, DID, DID2167A
-- Abstract :
-- This system is a collection of templates for all the
-- Data Item Descriptors (DIDs) documented in DoD-STD-2167A.
-- These templates are to be edited and tailored by the user
-- for his specific project. They contain instructions to the
-- user, telling him what items of information to insert at
-- various points in the template. The user replaces these
-- instructions with the information itself, transforming the
-- template into the document. Once the tailoring is complete
-- and all items required by the DID are filled in by the user,
-- the user may then execute the Portable Text Formatter (PTF)
-- to process the edited template into the formatted
-- deliverable document. The required section numbering, page
-- numbering, headers, table of contents, list of figures, list
-- of tables, and index will be generated automatically by PTF
-- in the format required by the DID.
--
-- This system consists of two sets of files: (1) the
-- common files, which are filled in once by the user and are
-- then read by the templates during their processing by PTF,
-- and (2) the DID templates themselves, where each
-- DoD-STD-2167A DID maps to one of the DID templates. The
-- common files provide information, such as the name of the
-- system, an overview of the system, and a list of acronyms,
-- which are needed by all or most of the DID templates. The
-- common files eliminate duplication of effort on the part of
-- the user by putting information needed by one or more DID in
-- a common location that can be read by the template. The DID
-- templates contain all the PTF commands and instructions to
-- the user for their use. The user instructions are always
-- enclosed in square brackets ([]), and, as the user works
-- with a template, he can read the instructions, input the
-- required information, and then delete everything within the
-- square brackets as he goes. The instructions in the square
-- brackets are, in effect, replaced by the information of the
-- DID itself. In some cases, the DID templates are
-- stand-alone; the user does not need to refer to the
-- DoD-STD-2167A DID to fill out the template. In other cases,
-- the DID template refers to the DoD-STD-2167A DID for more
-- information.
--
-- The documentation provided with this system is a
-- Software User's Manual (DID DI-MCCR-80019A) and a Version
-- Description Document (DID DI-MCCR-80013A). This
-- documentation was prepared as outlined above from the
-- respective DID templates and provides a living example of
-- this system in action. Other examples of this system in
-- action can be found in the Ada Software Repository (ASR) in
-- the Proposed MIL-HDBK-1804 documents and in the
-- documentation for the Portable Text Formatter (PTF).
--
-- This system represents an interpretation of the
-- DoD-STD-2167A document and its DIDs, and, while great care
-- was taken to be correct, errors may have been introduced.
-- Please report any such errors to the Manager, Ada Software
-- Repository. This system is a project of the Ada Software
-- Repository activity at White Sands and is not necessarily
-- endorsed by the United States Department of Defense as an
-- official representation of DoD-STD-2167A.
------------------ Revision history ---------------------------
-- DATE VERSION AUTHOR HISTORY
-- 14 Sep 89 1 Richard Conn Initial Release
-- 15 May 90 2 Richard Conn Added PCR
------------------ Distribution and Copyright -----------------
-- This prologue must be included in all copies of this software.
--
-- This software is released to the Ada community.
-- This software is released to the Public Domain (note:
-- software released to the Public Domain is not subject
-- to copyright protection).
-- Restrictions on use or distribution: NONE
------------------ Disclaimer ---------------------------------
-- This software and its documentation are provided "AS IS" and
-- without any expressed or implied warranties whatsoever.
-- No warranties as to performance, merchantability, or fitness
-- for a particular purpose exist.
--
-- Because of the diversity of conditions and hardware under
-- which this software may be used, no warranty of fitness for
-- a particular purpose is offered. The user is advised to
-- test the software thoroughly before relying on it. The user
-- must assume the entire risk and liability of using this
-- software.
--
-- In no event shall any person or organization of people be
-- held responsible for any direct, indirect, consequential
-- or inconsequential damages or lost profits.
-------------------END-PROLOGUE--------------------------------
--::::::::::
--did2167a.src
--::::::::::
--::::::::::
--acronyms.ptf
--::::::::::
.comment
.! This include file contains a table of acronyms which is used
.! in many of the DoD-STD-2167A documents.
.comment
.sp 2
.ce
.ul
Acronyms
.sp 1
.nf
.na
.need 22
.ul
Acronym Meaning
CDR Criticial Design Review
CDRL Contract Data Requirements List
CIDS Critical Item Development Specification
CRISD Computer Resources Integrated Support Document
CSC Computer Software Component
CSCI Computer Software Configuration Item
CSOM Computer System Operator's Manual
CSU Computer Software Unit
DID Data Item Description
DOD Department of Defense
DODISS Department of Defense Index of Specifications and Standards
ECP Engineering Change Proposal
FAR Gederal Acquisition Regulation
FCA Functional Configuration Audit
FSM Firmware Support Manual
FQT Formal Qualification Testing
GFE Government Furnished Equipment
GFI Government Furnished Information
GFS Government Furnished Software

.need 12
.ul
Acronym Meaning
HOL High Order Language
HWCI Hardware Configuration Item
ICD Interface Control Document
IDD Interface Design Document
I/O Input/Output
IRS Interface Requirements Specification
IV&V Independent Verification and Validation
NDS Non-development Software
PCA Physical Configuration Audit
PCR Problem/Change Report
PDR Preliminary Design Review
PIDS Prime Item Development Specification

.need 20
.ul
Acronym Meaning
SCN Specification Change Notice
SDD Software Design Document
SDF Software Development File
SDL Software Development Library
SDP Software Development Plan
SDR Software Design Review
SOW Statement of Work
SPM Software Programmer's Manual
SPS Software Product Specification
SRR Software Requirements Review
SRS Software Requirements Specification
SSDD System/Segment Design Document
SSR Software Specification Review
SSS System/Segment Specification
STD Software Test Description
STP Software Test Plan
STR Software Test Report
SUM Software User's Manual

.comment
.! This is set for PICA type (10 chars/inch). Change accordingly
.! for ELITE or other type styles. Also, the default top and bottom
.! margins and headers are used, giving 1 inch top and bottom for
.! both margins and headers at 6 lines/inch. No auto-paragraphing.
.!
.! Number registers used are a, b, and p.
.comment
.lm 11
.rm 70

.comment
.! Useful Macros (note that macros are in upper-case):
.!
.! .SECT
.! -- define a section which appears in the document and the
.! -- table of contents
.!
.! .LIST
.! -- start a list of items; the list will be indented from the
.! -- right and left by the indicated number of spaces;
.! -- nothing is output by this macro -- only the indentation
.! -- is changed and the number of the next list element
.! -- is set
.!
.! .LE
.! -- enter a new list item into the list; this may be
.! -- followed by more lines containing text associated
.! -- with the list entry; a blank line is generated followed
.! -- by a list element number, a period, and extended
.! -- to the left by the set by
.! -- the .LIST macro
.!
.! .ELIST
.! -- end a list of items; the indentation set by .LIST is
.! -- unset; a break is issued
.!
.! .SLIST
.! -- start a sublist of items while in a list; the sublist will
.! -- be further indented from the right and left by the
.! -- indicated number of spaces
.!
.! .SLE
.! -- enter a new list item into the sublist; this may be
.! -- followed by more lines containing text associated
.! -- with the sublist entry; a blank line is generated
.! -- followed by N.M (N=list element number, M=sublist number),
.! -- a period, and extended to the left by the
.! -- set by the .SLIST macro
.!
.! .ESLIST
.! -- end a sublist of items and continue with the list
.!
.! .PP
.! -- skip a line and start a new paragraph, indented by 5
.! -- spaces
.!
.! .FIG
.! -- enter a figure into the "List of Figures"
.!
.! .PRFIG
.! -- print the "List of Figures"
.!
.! .TAB
.! -- enter a table into the "List of Tables"
.!
.! .PRTAB
.! -- print the "List of Tables"
.!
.! .PCRSTART
.! -- start a new Problem/Change Report
.!
.! .PCRSECT <section title text>
.! -- start a new section in a Problem/Change Report
.!
.comment

.comment
.! The following reads in a set of macros used by all the 2167A
.! document templates. It also establishes the environment of the
.! document (PICA or ELITE type, for instance).
.comment
.include header.ptf

.comment
.! Set the page heading to contain the Document Control
.! Number and date. The Document Control Number contains
.! revision and volume identification as applicable.
.comment
.he //[DCN date: Volume x of y (if multi-volume)]//

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SYSTEM SPECIFICATION
( OR SEGMENT SPECIFICATION )
.sp
FOR THE
.sp
@SYSNAME

.spaceto -20
.comment
.! The contract number and other information appear here
.comment
CONTRACT NO. [contract number]
.sp
CDRL SEQUENCE NO. [CDRL number]
.sp 2
Prepared for:
.sp
[Contracting Agency Name, department code]
.sp 2
Prepared by:
.sp
[contractor name and address]
.ce off
.sp 2
.nf
.na
.ec \
Authenticated by _________________ Approved by _____________________
(Contracting agency) (Contractor)

Date _____________________________ Date ____________________________
.ec
.fi

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 this specification shall be considered a superseding
requirement, except for specification [enter number of next higher-tiered
specification] listed below.
.nap
.sp 2
.ul
Specifications
.sp 1
.ti +5
.ul
Federal
.PP
[List Federal specifications here.]
.sp 1
.ti +5
.ul
Military
.PP
[List Military specifications here.]
.sp 1
.ti +5
.ul
Other Government Agency
.PP
[List Other Government Agency specifications here.]

.sp 2
.ul
Standards
.sp 1
.ti +5
.ul
Federal
.PP
[List Federal standards here.]
.sp 1
.ti +5
.ul
Military
.PP
[List Military standards here.]
.sp 1
.ti +5
.ul
Other Government Agency
.PP
[List Other Government Agency standards here.]

.sp 2
.ul
Drawings
.PP
[Where detailed drawings referred to in a specification are listed on an
assembly drawing, it is only necessary to list the assembly drawing.]

.sp 2
.ul
Other Publications
.sp 1
.ti +5
.ul
Manuals
.PP
[List manuals here.]
.sp 1
.ti +5
.ul
Regulations
.PP
[List regulations here.]
.sp 1
.ti +5
.ul
Handbooks
.PP
[List handbooks here.]
.sp 1
.ti +5
.ul
Bulletins
.PP
[List bulletins here.]

.sp 2
.ap
.PP
[The following paragraph must appear now:]

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.
.nap
.SECT 1 2.2. Non-Government documents
.ap
.PP
[This paragraph shall begin with the following paragraph:]

.sp 2
.ul
Specifications
.PP
[List non-government specifications here.]
.sp
.ti +5
.ul
Standards
.PP
[List non-government standards here.]
.sp
.ti +5
.ul
Drawings
.PP
[List non-government drawings here.]
.sp
.ti +5
.ul
Other publications
.PP
[List other non-government publications here.]
.ap
.PP
[The following paragraph shall be placed at the conclusion 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.
.nap
.bp
.cl
.SECT 0 3. System requirements
.PP
[This section shall be divided into the following paragraphs and
subparagraphs to specify the requirements for the system to which this
specification applies.]
.SECT 1 3.1. Definition
.PP
[This paragraph shall provide a brief description of the
system. This description shall address pertinent operational, and
logistical considerations and concepts. A system diagram shall be provided.]
.SECT 1 3.2. Characteristics
.PP
[This paragraph shall be divided into the following subparagraphs
to describe the requirements for system performance and physical
characteristics.]
.SECT 2 3.2.1. Performance characteristics
.PP
[This subparagraph shall be divided into the following subparagraphs to
specify the system's capabilities in the context of the states
in which the system can exist and the modes of operation within each
state. Each capability of the system shall be specified in a uniquely
identified subparagraph in order to provide for objective
qualification.]
.SECT 3 3.2.1.X. [State name]
.PP
[This subparagraph shall identify and provide a brief description of
a state in which the system can exist (e.g., weapon idle,
weapon ready, weapon deployed).]
.SECT 4 3.2.1.X.Y. [Mode name]
.PP
[This subparagraph shall identify and provide a brief description of a mode
of operation (e.g., surveillance, threat evaluation, weapon assignment,
target designation and acquisition, fire control resolution) within the
system state identified above.]
.SECT 5 3.2.1.X.Y.Z. [System capability name and project unique identifier]
.PP
[This subparagraph shall specify a capability of the system by name and
project unique identifier, and shall describe its purpose. This
subparagraph shall also identify the applicable parameters associated
with the capability and shall express them in measurable terms. If a
capability of a mode has been previously defined, this subparagraph
shall reference rather than duplicate that information.]
.SECT 2 3.2.2. System capability relationships
.PP
[This subparagraph shall summarize the relationships between system
capabilities and the states and modes of the system.]
.SECT 2 3.2.3. External interface requirements
.PP
[This paragraph shall be divided into the following subparagraphs to describe
requirements for interfaces with other systems. Detailed
quantitative interface requirements may be defined in separate specifications
or Interface Control Documents (ICDs) and referenced herein. All referenced ICDs are
considered part of this specification.]
.SECT 3 3.2.3.X. [System name] external interface description
.PP
[This subparagraph shall identify an external system with which this system
interfaces. This subparagraph shall describe the interfaces to the external
system. This subparagraph shall identify the purpose of each interface and
shall describe the relationship between each interface and the states and modes
of the system. When possible, each interface shall be specified in detailed,
quantitative terms (e.g., dimensions, tolerances, loads, speeds,
communications protocol).
.SECT 2 3.2.4. Physical characteristics
.PP
[This subparagraph shall specify the requirements for the physical
characteristics (e.g., weight limits, dimensional units) of the
system. Additional considerations for determining physical requirements
include:
.LIST 4
.LE Transportation and storage
.LE Security
.LE Durability
.LE Safety
.LE Vulnerability
.LE Color
.ELIST
.SECT 3 3.2.4.1. Protective coatings
.PP
[This subparagraph shall specify, if applicable, protective coating
requirements to assure protection from corrosion, abrasion, or other
deleterious action.]
.SECT 2 3.2.5. System quality factors
.PP
[This paragraph shall be divided into the following subparagraphs
to specify the applicable requirements pertaining to system quality factors.]
.SECT 3 3.2.5.1. Reliability
.PP
[This subparagraph shall specify reliability requirements in quantitative
terms, and shall define the conditions under which the reliability
requirements are to be met. This subparagraph may include a reliability
apportionment model to support apportionment of reliability values
assigned to system capabilities for their share in achieving desired
system reliability.]
.SECT 3 3.2.5.2. Maintainability
.PP
[This subparagraph shall specify quantitative maintainability requirements.]
.SECT 3 3.2.5.3. Availability
.PP
[This subparagraph shall specify the degree to which the system shall be in an
operable and committable state at the start of the mission(s), where the
mission(s) is called for at an unknown (random) point in time.]
.SECT 3 3.2.5.4. Additional quality factors
.PP
[This subparagraph shall specify system quality requirements not defined
in the above subparagraphs.]
.SECT 2 3.2.6. Environmental conditions
.PP
[This subparagraph shall specify the environmental conditions that the system
must withstand during transportation, storage, and operation.]
.SECT 2 3.2.7. Transportability
.PP
[This subparagraph shall specify any special requirements for transportation
and materials handling. In addition, all system elements that, due to
operational or functional characteristics, will be unsuitable for normal
transportation methods shall be identified.]
.SECT 2 3.2.8. Flexibility and expansion
.PP
[This subparagraph shall specify areas of growth which require planning
for system flexibility and expansion. In addition, this subparagraph
shall specify specific system elements which require spare capacity
to support flexibility and expansion.]
.SECT 2 3.2.9. Portability
.PP
[This subparagraph shall specify requirements for portability which are
applicable to the system to permit employment, deployment, and logistic
support.]
.SECT 1 3.3. Design and construction
.PP
[This paragraph shall be divided into subparagraphs that specify minimum
system design and construction standards which have general applicability to
system equipment and are applicable to major classes of equipment
(e.g., aerospace vehicle equipment, support equipment) or are
applicable to particular design standards.]
.SECT 2 3.3.1. Materials
.PP
[This subparagraph shall specify those system-peculiar requirements
governing use of materials, parts, and processes in the design of system
equipment. Special attention shall be directed to prevent unnecessary
use of strategic or critical materials.]
.SECT 3 3.3.1.1. Toxic products and formulations
.PP
[This subparagraph shall specify requirements for the control of toxic
products or formulations to be used in the system or to be generated by
the system.]
.SECT 2 3.3.2. Electromagnetic radiation
.PP
[This subparagraph shall contain requirements pertaining to limits on the
electromagnetic radiation which the system is permitted to generate.]
.SECT 2 3.3.3. Nameplates and product marking
.PP
[This subparagraph shall contain requirements for nameplates, part marking,
serial and lot number marking, software media marking, and other
identifying markings required for the system.]
.SECT 2 3.3.4. Workmanship
.PP
[This subparagraph shall specify workmanship requirements for equipment
to be produced during system development and requirements for
manufacture by production techniques.]
.SECT 2 3.3.5. Interchangeability
.PP
[This subparagraph shall specify the requirements for system
equipment to be interchangeable and replaceable.]
.SECT 2 3.3.6. Safety
.PP
[This subparagraph shall specify those safety requirements which are basic to
the design of the system, with respect to equipment characteristics,
methods of operation, and environmental influences.]
.SECT 2 3.3.7. Human engineering
.PP
[This subparagraph shall specify human engineering requirements for the
system or for specific configuration items.]
.SECT 2 3.3.8. Nuclear control
.PP
[This subparagraph shall specify system requirements for nuclear components.]
.SECT 2 3.3.9. System security
.PP
[This subparagraph shall specify security requirements that are basic to the
design of the system with respect to the operational environment of
the system.]
.SECT 2 3.3.10. Government furnished property usage
.PP
[This subparagraph shall specify any Government Furnished Equipment (GFE)
to be incorporated into the system design. In addition, this
subparagraph shall specify any Government Furnished Information (GFI)
and Government Furnished Software (GFS) to be incorporated into the system.]
.SECT 2 3.3.11. Computer resource reserve capacity
.PP
[This subparagraph shall specify the required computer resource
reserve capacity (e.g., memory, timing).]
.SECT 1 3.4. Documentation
.PP
[This paragraph shall specify the requirements for system documentation
such as specifications, drawings, technical manuals, test plans and
procedures, and installation instruction data.]
.SECT 1 3.5. Logistics
.PP
[This paragraph shall specify logistic considerations and conditions that
apply to the operational requirements.]
.SECT 1 3.6. Personnel and training
.PP
[This paragraph shall be divided into the following subparagraphs
to specify the requirements for personnel and training.]
.SECT 2 3.6.1. Personnel
.PP
[This subparagraph shall specify personnel requirements which must be
integrated into system design.]
.SECT 2 3.6.2. Training
.PP
[This subparagraph shall include the following training requirements:
.LIST 4
.LE Contractor and Government responsibility for training.
.LE Equipment that will be required for training purposes.
.LE Training devices to be developed, characteristics of the training
devices, and training and skills to be developed through the use of
training devices.
.LE Training timing and locations available for a training program.
.LE Source material and training aids to support the specified training.]
.ELIST
.SECT 1 3.7. Characteristics of subordinate elements
.PP
[This paragraph shall be divided into the following subparagraphs to
identify and describe each segment of the system. This paragraph shall
describe the relationships between the segments.]
.SECT 2 3.7.X. [Segment name and project unique identifier]
.PP
[This subparagraph shall provide the following information for the segment:
.LIST 4
.LE State the purpose of the segment.
.LE Provide a brief description of the segment.
.LE Identify the system capabilities the segment performs.]
.ELIST
.SECT 1 3.8. Precedence
.PP
[This paragraph shall either specify the order of precedence of the
requirements or assign weights to indicate the relative importance of the
requirements.]
.SECT 1 3.9. Qualification
.PP
[This paragraph shall state the requirements for verification or
validation, as applicable, of capabilities in a specific application.]
.SECT 1 3.10. Standard sample
.PP
[This paragraph shall describe, if applicable, requirements for the production
of one or more standard samples.]
.SECT 1 3.11. Preproduction sample, periodic production sample, pilot,
or pilot lot
.PP
[This paragraph shall describe, if applicable, requirements for producing a
preproduction or periodic production sample, a pilot model, or a pilot lot.]
.bp
.cl
.SECT 0 4. Quality assurance provisions
.PP
[This section shall be divided into the following paragraphs
to specify the requirements to show how the requirements of
sections 3 and 5 shall be satisfied.]
.SECT 1 4.1. Responsibility for inspection
.PP
[This paragraph shall assign responsibilities for performance of
inspections of delivered products, materials, or services for
determining compliance with all specified requirements.]
.SECT 1 4.2. Special tests and examinations
.PP
[This paragraph shall specify any special tests and examinations required
for sampling, lot formation, qualification evaluation, and any
other tests or examinations as necessary.]
.SECT 1 4.3. Requirements cross reference
.PP
[This paragraph shall correlate each system requirement in sections 3 and 5
to the quality assurance provisions specified in section 4.]
.bp
.cl
.SECT 0 5. Preparation for delivery
.PP
[This section shall specify requirements for the preparation of the system
and all its components for delivery, including packaging and handling.]
.bp
.cl
.SECT 0 6. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in understanding
this document (e.g., background information, glossary, formula derivations).]
.SECT 1 6.1. Intended use
.PP
[This paragraph shall briefly state the purpose of the system to which
the SSS applies in terms of the mission and threat addressed by the system.]
.SECT 2 6.1.1. Missions
.PP
[This subparagraph shall describe the missions of the system to the extent
that such missions affect design requirements.]
.SECT 2 6.1.2. Threat
.PP
[This subparagraph shall describe the characteristics of
potential targets, the characteristics of current and potential enemy
weapon capabilities relevant to the system, and any additional threat
considerations that affect the system design.]

.comment
.! This appends a blank page to the end of a main body or
.! appendix of the document. This blank page may be removed
.! if it is numbered odd or retained if it is even.
.comment
.bp
.sp 20
.ce
This page intentionally blank

.comment
.! End of blank page
.comment

.bp 1
.pn arabic A-#
.cl
.SECT 0 A. Appendixes
.PP
[Appendixes may be used to provide information published
separately for convenience in document maintenance (e.g., charts,
classified data). As applicable, each appendix shall
be referenced in the main body of the document where the data would
normally have been provided. Appendixes may be bound as separate
documents for ease of handling. Appendixes shall be lettered
alphabetically (A, B, etc.), and the paragraphs within each appendix
be numbered as multiples of 10 (e.g., Appendix A, paragraph 10,
10.1, 10.2, 20, 20.1, 20.2, etc.). Pages within each appendix shall
be numbered alpha-numerically as follows: Appendix A pages shall be numbered
A-1, A-2, A-3, etc. Appendix B pages shall be numbered
B-1, B-2, B-3, etc.]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SYSTEM DESIGN DOCUMENT
( OR SEGMENT DESIGN DOCUMENT )
.sp
FOR THE
.sp
@SYSNAME

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE DESIGN DOCUMENT
.sp
FOR THE
.sp
.comment
.! The name of the CSCI appears here
.comment
[CSCI NAME]
.sp
OF
.sp
@SYSNAME

.ce off

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number,
title, and abbreviation, if applicable, of the CSCI and the system to
which this SDD applies. This paragraph shall identify the higher-level
specification(s) containing the requirements from which the design of
this CSCI was derived.]
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Documentation overview
.PP
[This paragraph shall summarize the purpose and contents of this
document.]
.bp
.cl
.SECT 0 2. Referenced documents
.PP
[This section shall list by document number and title all documents
referenced in this document. This section shall also
identify the source for all documents not available through normal Government
stocking activities.]
.bp
.cl
.SECT 0 3. Preliminary design
.PP
[This section shall be divided into the following paragraphs to describe the
preliminary design of the CSCI.]
.SECT 1 3.1. CSCI overview
.PP
[This paragraph shall identify and describe the role of the CSCI within the
system to which this SDD applies. The overview shall identify and state
the purpose of each external interface of the CSCI. A system architecture
diagram may be used to show the relationships between this CSCI and the other
CIs in the system.]
.SECT 2 3.1.1. CSCI architecture
.PP
[This paragraph shall describe the internal organizational structure of the
CSCI. The Computer Software Components (CSCs) and the sub-level CSCs shall
be identified and their purpose summarized. The relationships among the
CSCs shall be described. The relationship description shall identify and
state the purpose of each CSC-to-CSC interface and shall summarize the
data transmitted via the interface. This paragraph shall identify any
non-developmental software to be incorporated into the CSCI. The CSCI
top-level architecture may be illustrated graphically.]
.SECT 2 3.1.2. System states and modes
.PP
[This paragraph shall identify each system state and mode in which the CSCI
operates and the CSCs that execute in each state and mode. A state/CSC
table may be provided to illustrate the system states and modes that each
CSC executes. In addition, this paragraph shall describe the general flow
of both execution control and data between CSCs while operating in the
different states and modes. A flow diagram(s) may be used to illustrate
the execution control and data flow in each state and mode.]
.SECT 2 3.1.3. Memory and processing time allocation
.PP
[This paragraph shall document the allocation of memory and processing time
to the CSCs. The allocation may be illustrated by a memory/processing
time table (see Table I in DI-MCCR-80012A).]
.SECT 1 3.2. CSCI design description
.PP
[This section shall be divided into the following subparagraphs to
provide a design description of each CSC of the CSCI.]
.SECT 2 3.2.1. [CSC name and project unique identifier]
.PP
[This subparagraph (and other paragraphs like it numbered 3.2.X)
shall identify a CSC by name and project unique identifier,
and shall state its purpose. This subparagraph shall provide the following
information:
.LIST 4
.LE
Identify the requirements allocated to the CSC from the applicable
requirements specification(s). If the CSC is composed of sub-level CSCs,
some or all of this information may be referenced and provided by the
sub-level CSC description.
.LE
Describe the preliminary design of the CSC in terms of execution control
and data flow. If a CSC is composed of sub-level CSCs, this description
shall identify the relationships among the sub-level CSCs. In addition, this
description shall identify each CSCI internal interface documented in the
Software Requirements Specification, that is to be addressed by the CSC
and its sub-level CSCs, as applicable. This information may be referenced
rather than duplicated for each sub-level CSC.]
.LE
Identify the derived design requirements for the CSC and any design constraints
imposed on or by the CSC. If the CSC is composed of sub-level CSCs, some
or all of this information may be referenced and provided by the sub-level
CSC description.]
.ELIST
.SECT 3 3.2.1.1. [Sub-level CSC name and project unique identifier]
.PP
[This subparagraph (and other subparagraphs like it numbered 3.2.X.Y)
shall identify a sub-level CSC by name and project unique identifier,
shall state its purpose, and shall provide the information required by
(1) through (3) above. This subparagraph does not apply if there are no
sub-level CSCs. If this CSC is also composed of sub-level CSCs, each
sub-level CSC shall be identified by name and project unique identifier
and the information required by (1) through (3) above shall be provided in a
separate subparagraph for each sub-level CSC.]
.bp
.cl
.SECT 0 4. Detailed design
.PP
[This section shall be divided into the following paragraphs and subparagraphs
to describe the detailed design of each CSC. See DI-MCCR-80012A for a
detailed description of these paragraphs and subparagraphs.]
.SECT 1 4.1. [CSC name and project unique identifier]
.PP
[This paragraph (and others like it numbered 4.X) shall be divided into the
following subparagraphs to identify and describe each of the
Computer Software Units (CSUs) of a CSC.]
.SECT 2 4.1.1. [CSU name and project unique identifier]
.PP
[This subparagraph (and others like it numbered 4.X.Y) shall identify a
CSU by name and project unique identifier and shall state the
purpose of the CSU.]
.SECT 3 4.1.1.1. [CSU name] Design specification/constraints
.PP
[This subparagraph (and others like it numbered 4.X.Y.1) shall state the
design requirements for the CSU.]
.SECT 3 4.1.1.2. [CSU name] Design
.PP
[This subparagraph (and others like it numbered 4.X.Y.2) shall specify
the design of the CSU.]
.bp
.cl
.SECT 0 5. CSCI data
.PP
[This section shall describe the global data elements within the
CSCI.]
.bp
.cl
.SECT 0 6. CSCI data files
.PP
[This section shall be divided into the following paragraphs to
describe each of the shared data files of the CSCI.]
.SECT 1 6.1. Data file to CSC/CSU cross reference
.PP
[This paragraph shall provide a mapping of each data file identified below
to the CSCs and CSUs that use the data file.]
.SECT 1 6.2. [Data file name and project unique identifier]
.PP
[This subparagraph (and others like it numbered 6.X) shall identify by name
and project unique identifier a data file of the CSCI that is shared
by more than one CSU.]
.bp
.cl
.SECT 0 7. Requirements traceability
.PP
[This section shall provide traceability of the requirements allocated down
to the CSU level of each CSC back to the requirements of the
Software Requirements Specification and Interface Requirements Specification.
The traceability may be shown graphically.]
.bp
.cl
.SECT 0 8. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in understanding
this document (e.g., background information, glossary, formula derivations).]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
VERSION DESCRIPTION DOCUMENT
.sp
FOR THE
.sp
.comment
.! The name of the CSCI appears here
.comment
[CSCI NAME]
.sp
OF
.sp
@SYSNAME

.ce off

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number,
title, and abbreviation, if applicable, of the CSCI and the system to
which this VDD applies.]
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Documentation overview
.PP
[This paragraph shall summarize the purpose and contents of this
document.]
.bp
.cl
.SECT 0 2. Referenced documents
.PP
[This section shall list by document number and title all documents
referenced in this document. This section shall also
identify the source for all documents not available through normal Government
stocking activities.]
.bp
.cl
.SECT 0 3. Version description
.SECT 1 3.1. Inventory of materials released
.PP
[This paragraph shall list all physical media (e.g., listings, tapes,
cards, disks) and associated documentation that make up the new
version. This paragraph shall also identify all operation and
support documents that are not a part of the delivered package, but
that are required to operate, load, or regenerate the CSCI.]
.SECT 1 3.2. Inventory of CSCI contents
.PP
[This paragraph shall identify all computer software that is part of the
delivered CSCI. This software shall be identified in the same sequence
as is used to organize the source code listings for delivery.]
.SECT 1 3.3. Class I changes installed
.PP
[This paragraph shall contain a list of all Class I changes
(as defined in DOD-STD-480) incorporated into the CSCI since the
previous version, with a cross reference to the affected CSCI specifications.
This paragraph shall also indicate for each entry in this list the ECP
number and date and the the related SCN number and date. Note: This
paragraph does not apply to the initial version of a CSCI.]
.SECT 1 3.4. Class II changes installed
.PP
[This paragraph shall contain a list of all Class II changes
(as defined in DOD-STD-480) incorporated into the CSCI since the
previous version, with a cross reference to the affected CSCI
specifications. This paragraph shall also indicate for each entry
in this list the ECP number and date, and the related SCN number
and date. Note: This paragraph does not apply to the initial version
of a CSCI.]
.SECT 1 3.5. Adaptation data
.PP
[For the initial release of a CSCI, this paragraph shall identify
or reference all unique-to-site data contained in the items being
delivered. For subsequent CSCI versions, this paragraph shall contain
the information necessary to identify changes made to the
adaptation data.]
.SECT 1 3.6. Interface compatibility
.PP
[This paragraph shall indicate other systems and configuration items
affected by the changes incorporated in this version. Note: This
paragraph does not apply to the initial version of a CSCI.]
.SECT 1 3.7. Bibliography of reference documents
.PP
[For the initial version of a CSCI, this paragraph shall list
all documents pertinent to the CSCI. For subsequent CSCI versions,
this paragraph shall identify changes to the listed documents.]
.SECT 1 3.8. Summary of change
.PP
[This paragraph shall contain a subparagraph describing the operational
effect of each ECP listed in 3.3 and 3.4 above.]
.SECT 1 3.9. Installation instructions
.PP
[This paragraph shall provide the instructions (either directly or
by reference) for installing the CSCI version.]
.SECT 1 3.10. Possible problems and known errors
.PP
[This paragraph shall identify any possible problems or known errors
with the CSCI version and any steps being taken to resolve the problems
or errors.]
.bp
.cl
.SECT 0 4. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in
understanding this document (e.g., background information, glossary).]

.comment
.! End of blank page
.comment

.bp 1
.pn arabic A-#
.cl
.SECT 0 A. Problem/Change Report Priority Descriptions
.sp 2
.include pcrdesc.ptf
.bp
.sp 20
.ce
This Page Intentionally Blank
.bp 1
.pn arabic B-#
.cl
.SECT 0 B. Problem/Change Reports Applicable to this VDD
.! This example contains two samples PCRs, showing how multiple
.! PCRBODY files can be created and reused.
.sp 2
.include pcrbody.ptf
.bp
.include pcrbody.ptf
.bp
.sp 20
.ce
This Page Intentionally Blank
.bp 1
.pn arabic C-#
.cl
.SECT 0 C. Other Appendices
.PP
[Appendixes may be used to provide information published
separately for convenience in document maintenance (e.g., charts,
classified data). As applicable, each appendix shall
be referenced in the main body of the document where the data would
normally have been provided. Appendixes may be bound as separate
documents for ease of handling. Appendixes shall be lettered
alphabetically (A, B, etc.), and the paragraphs within each appendix
be numbered as multiples of 10 (e.g., Appendix A, paragraph 10,
10.1, 10.2, 20, 20.1, 20.2, etc.). Pages within each appendix shall
be numbered alpha-numerically as follows: Appendix A pages shall be numbered
A-1, A-2, A-3, etc. Appendix B pages shall be numbered
B-1, B-2, B-3, etc.]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE TEST PLAN
.sp
FOR THE
.sp
@SYSNAME

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE TEST DESCRIPTION
.sp
FOR THE
.sp
.comment
.! The name of the CSCI appears here
.comment
[CSCI NAME]
.sp
OF
.sp
@SYSNAME

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE TEST REPORT
.sp
FOR THE
.sp
.comment
.! The name of the CSCI appears here
.comment
[CSCI NAME]
.sp
OF
.sp
@SYSNAME

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
COMPUTER SYSTEM OPERATOR'S MANUAL
.sp
FOR THE
.sp
.comment
.! The name of the computer system appears here
.comment
[COMPUTER SYSTEM NAME]
.sp
OF
.sp
@SYSNAME

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE USER'S MANUAL
.sp
FOR THE
.sp
@SYSNAME

.ce off

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number(s),
version number, release number, title(s), and
abbreviation(s), if applicable, of the CSCI(s) and the system to
which this SUM applies.]
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Document overview
.PP
[This paragraph shall summarize the purpose and contents of this
manual.]
.bp
.cl
.SECT 0 2. Referenced documents
.PP
[This section shall list by document number and title all documents
referenced in this manual. This section shall also
identify the source for all documents not available through normal Government
stocking activities.]
.bp
.cl
.SECT 0 3. Execution procedures
.PP
[This section shall present the information and instructions necessary
for user interaction with the CSCI(s) in order to carry out the
operation of the software. This subparagraph shall describe the
step-by-step procedures for executing the software and shall identify
the options available to the user. Reference may be made to an operator's
manual for the computer system operating procedures (e.g. Computer
System Operator's Manual (CSOM), DI-MCCR-80018). The procedures shall
include the following information as applicable:
.li +4
.LIST 4
.LE Initialization
Describe the initialization procedures necessary to execute the
software. Identify any initialization options available to the user.
.LE User inputs
Describe the user inputs to the software.
.LE System inputs
Describe the system inputs to the software that may occur while the
software is in use and that may affect the software's interface with the user
(e.g., inputs from a remote sensor). Include format, frequency,
allowable range, and units of measure, as applicable.
.LE Termination
Describe how to terminate software operation and how the user can
determine whether normal termination has occurred.
.LE Restart
Describe the procedures for restarting the software.
.LE Outputs
Describe expected outputs of the software, including error messages.]
.ELIST
.li -4
.bp
.cl
.SECT 0 4. Error messages
.PP
[This section shall identify all error messages output by the software,
the meaning of each error message, and the action to be taken when
each message appears.]
.bp
.cl
.SECT 0 5. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in
understanding this document (e.g., background information, glossary).]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE PROGRAMMER'S MANUAL
.sp
FOR THE
.sp
.comment
.! The name of the computer system appears here
.comment
[COMPUTER SYSTEM NAME]
.sp
OF
.sp
@SYSNAME

.ce off

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number(s),
title(s), and
abbreviation(s), if applicable, of the system,
Computer Software Configuration Items (CSCI(s)), the host
computer(s), and the target computer(s) to which this SPM applies.]
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Document overview
.PP
[This paragraph shall summarize the purpose and contents of this
manual.]
.bp
.cl
.SECT 0 2. Referenced documents
.PP
[This section shall list by document number and title all documents
referenced in this manual. This section shall also
identify the source for all documents not available through normal Government
stocking activities.]
.bp
.cl
.SECT 0 3. Software programming environment
.PP
[This section shall be divided into multiple paragraphs and subparagraphs
as appropriate to describe the host and target computer(s) operating
system, and other software involved in loading, compiling, and executing
the software. If information required below is provided in a commercially
available document, that document shall be referenced by title,
number, and applicable paragraph(s).
.li +4
.LIST 4
.LE Equipment configuration
Describe the components and configuration of the host and target
computer systems.
.LE Operational information
Describe the operating characteristics, capabilities, and limitations
of the host and target computer systems. Include, as applicable:
.SLIST 4
.SLE Machine cycle time
.SLE Word length
.SLE Memory capacity and characteristics
.SLE Instruction set characteristics
Such characteristics are augment capabilities and co-processor
availability.
.SLE Interrupt capabilities
.SLE Modes of operation
Such modes are batch, interactive, privileged, and non-privileged.
.SLE Operational registers
.SLE Error indicators
.SLE Input/output characteristics
.SLE Special features
.ESLIST
.LE Compilations, assemblies, and linkages
Describe the equipment (e.g., tapes, disks, other
peripheral equipment) necessary to perform compilations and assemblies
on the computer system. Identify (as applicable) by name and version
number the editor, linker, link-editor, compiler, assembler,
cross-compilers, cross-assemblers, and other utilities used, and reference
appropriate manuals describing their use. Highlight any special flags
or instructions necessary for loading, executing, or recording the results of
compilations and assemblies.]
.ELIST
.li -4
.bp
.cl
.SECT 0 4. Programming information
.PP
[This section shall be divided into multiple paragraphs as appropriate
to describe
programming information relative to the host and target computers. If the
information required below is provided in a commercially available
document, that document shall be referenced by title,
number, and applicable paragraph(s). If the host and target computers
are the same, the information shall be provided only once.
.li +4
.LIST 4
.LE Programming features
Describe the computer's instruction set architecture. Include, as
applicable:
.SLIST 4
.SLE data representation
Examples: byte, word, integer, floating-point, packed decimal,
and double precision.
.SLE Instruction formats and addressing modes
Examples: operation codes (OPCODEs), OPCODE formats, operand types, and
addressing (e.g., implicit, immediate, absolute, and branch relative).
.SLE Special registers and words
Examples: stack pointer, program counter, and processor status word.
.SLE Control instructions
Examples: branch, jump subroutine and procedure call instructions,
privileged instructions, and the modes they operate in.
.SLE Subroutines and procedures
Examples: non-reentrant, reentrant, macrocode routines,
argument lists, and parameter passing conventions (such as call by
name and call by value).
.SLE Interrupt processing
.SLE Timers and clocks
.SLE Memory protection features
Example: read-only.
.SLE Additional features
.ESLIST
.LE Program instructions
Describe each instruction in the computer's instruction set architecture.
For each instruction, include, as applicable:
.SLIST 4
.SLE Use
.SLE Syntax
.SLE Conditions codes set
.SLE Execution Time
.SLE Machine-code format
.SLE Mnemonic conventions
.SLE Other characteristics.
.ESLIST
.LE Input and output control programming
Describe the input and output control programming of the computer system.
Include, as applicable, descriptions of:
.SLIST 4
.SLE Initial loading and verification of computer memory
.SLE Serial and parallel data channels
.SLE Discrete inputs and outputs
.SLE Interface components
.SLE Device numbers, operational codes, and memory locations for
peripheral equipment.
.ESLIST
.LE Additional or special techniques
Describe additional or special programming techniques associated
with the computer system (e.g., a concise description of the microprogram
control section showing how the user instruction set is implemented
via microcode).
.LE Programming examples
Provide examples that demonstrate the programming features described above.
Include examples of the proper use of all categories of instructions on the
specific computer system.
.LE Error detection and diagnostic features
Describe the error detection and diagnostic features associated with
the computer system. Include condition codes, overflow and addressing
exception interrupts, and input and output error status indicators.]
.ELIST
.li -4
.bp
.cl
.SECT 0 5. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in
understanding this document (e.g., background information, glossary).]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
FIRMWARE SUPPORT MANUAL
.sp
FOR THE
.sp
@SYSNAME

.ce off

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number,
version numbers, CSCI revision number, title, and
abbreviation, if applicable, of the computer system to
which this FSM applies. This paragraph shall also identify by name
and number all firmware components to which this FSM applies.]
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Document overview
.PP
[This paragraph shall summarize the purpose and contents of this
manual.]
.bp
.cl
.SECT 0 2. Referenced documents
.PP
[This section shall list by document number and title all documents
referenced in this manual. This section shall also
identify the source for all documents not available through normal Government
stocking activities.]
.bp
.cl
.SECT 0 3. Firmware device information
.PP
[This section shall be divided into the following paragraphs to describe the
firmware devices.]
.SECT 1 3.1. Device description
.PP
[This paragraph shall contain a complete physical description of the firmware
components of the system.]
.SECT 1 3.2. Installation and repair procedures
.PP
[This paragraph shall contain all installation, replacement, and repair
procedures for the firmware devices.]
.SECT 1 3.3. Security
.PP
[This paragraph shall describe any security measures to be applied
to the devices and the supporting hardware and software.]
.SECT 1 3.4. Limitations
.PP
[This paragraph shall describe the operational and environmental limits
to which the devices may be subjected and still maintain satisfactory
operation.]
.bp
.cl
.SECT 0 4. Programming equipment and procedures
.PP
[This section shall be divided into the following paragraphs to provide
a description of the equipment, software, and procedures to be used for
programming and reprogramming all firmware components of the system.]
.SECT 1 4.1. Programming hardware
.PP
[This paragraph shall describe the equipment to be used for programming
and reprogramming each firmware device.]
.SECT 1 4.2. Programming software
.PP
[This paragraph shall describe the software to be used for programming
and reprogramming each firmware device, including software for device
loading, burn-in, and test.]
.SECT 1 4.3. Loading procedures
.PP
[This paragraph shall describe the procedures to be used for programming
and reprogramming each firmware device, including device loading,
verification, and test.]
.bp
.cl
.SECT 0 5. Vendor information
.PP
[This section shall include information supplied by the device vendor
or reference the appropriate commercially available document(s).]
.bp
.cl
.SECT 0 6. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in
understanding this document (e.g., background information, glossary).]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
COMPUTER RESOURCES
.sp
INTEGRATED SUPPORT DOCUMENT
.sp
FOR THE
.sp
@SYSNAME

.ce off

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number(s),
title(s), and
abbreviation(s), if applicable, of the CSCIs and the system to
which this CRISD applies. If the document applies to all CSCIs
in the system, this shall be stated.]
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Document overview
.PP
[This paragraph shall summarize the purpose and contents of this
manual.]
.bp
.cl
.SECT 0 2. Referenced documents
.PP
[This section shall list by document number and title all documents
referenced in this manual. This section shall also
identify the source for all documents not available through normal Government
stocking activities.]
.bp
.cl
.SECT 0 3. Support information
.PP
[This section shall be divided into the following paragraphs and
subparagraphs to provide the support information.]
.SECT 1 3.1. Software support resources
.PP
[This paragraph shall be divided into subparagraphs to identify and
describe the components of the software engineering and test environments
required to support the deliverable software.]
.SECT 2 3.1.1. Software
.PP
[This subparagraph shall identify and describe all of the
software and associated documentation required to support the deliverable
software.]
.SECT 2 3.1.2. Hardware
.PP
[This subparagraph shall identify and describe the hardware and the associated
documentation necessary to support the deliverable software.]
.SECT 2 3.1.3. Facilities
.PP
[This subparagraph shall describe the facilities required to
support the deliverable software and shall identify their purpose.]
.SECT 2 3.1.4. Personnel
.PP
[This subparagraph shall identify the personnel required to support the
deliverable software, including the types of skills, number of personnel,
security clearance, and skill level.]
.SECT 2 3.1.5. Other resources
.PP
[This subparagraph shall identify any other resources required for the support
environment not discussed above.]
.SECT 1 3.2. Operations
.PP
[This paragraph shall be divided into the following subparagraphs to describe
the operations necessary to support the deliverable software.]
.SECT 2 3.2.1. Software modification
.PP
[This subparagraph shall describe the procedures necessary to modify deliverable
operational and support software.]
.SECT 2 3.2.2. Software integration and testing
.PP
[This subparagraph shall describe the procedures necessary to integrate and
fully test all software modifications.]
.SECT 2 3.2.3. Software generation
.PP
[This subparagraph shall provide the information necessary to facilitate
compilations or assemblies of the contractually deliverable software.]
.SECT 2 3.2.4. Simulation
.PP
[If simulation is necessary to support the deliverable software, this
subparagraph shall detail the hardware, software, and procedures
necessary for the required simulation.]
.SECT 2 3.2.5. Emulation
.PP
[If emulation is necessary to support the deliverable software, this
subparagraph shall detail the hardware, software, and procedures
necessary for the required emulation.]
.SECT 1 3.3. Training
.PP
[This paragraph shall describe the contractor's plans for the
training of personnel to manage and implement support of the deliverable
software.]
.SECT 1 3.4. Anticipated areas of change
.PP
[This paragraph shall describe the anticipated areas of change to the
deliverable software.]
.bp
.cl
.SECT 0 4. Transition planning
.PP
[This section shall be divided into paragraphs and subparagraphs
as appropriate to describe the contractor's plans for transitioning the
deliverable software to the support agency.]
.bp
.cl
.SECT 0 5. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in
understanding this document (e.g., background information, glossary).]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE REQUIREMENTS SPECIFICATION
.sp
FOR THE
.sp
.comment
.! The name of the CSCI appears here
.comment
[CSCI NAME]
.sp
OF
.sp
@SYSNAME

Date _____________________________ Date ____________________________
.ec
.fi

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number,
title, and, if applicable,
abbreviation of the system and the CSCI to
which this SRS applies.]
.SECT 1 1.2. CSCI overview
.include overview.ptf
.PP
[This paragraph shall identify and describe the role, within the system,
of the CSCI to which this SRS applies.]
.SECT 1 1.3. Document overview
.PP
[This paragraph shall summarize the purpose and contents of this
manual.]
.bp
.cl
.SECT 0 2. Applicable documents
.SECT 1 2.1. Government documents
.ap
.PP
[This paragraph shall begin with one of the following two paragraphs, as
applicable [include only one of these two paragraphs]:]

.sp 2
.ul
Drawings
.PP
[Where detailed drawings referred to in a specification are listed on an
assembly drawing, it is only necessary to list the assembly drawing.]

.sp 2
.ap
.PP
[The following paragraph must appear now:]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
INTERFACE REQUIREMENTS SPECIFICATION
.sp
FOR THE
.sp
@SYSNAME

Date _____________________________ Date ____________________________
.ec
.fi

.sp 2
.ul
Drawings
.PP
[Where detailed drawings referred to in a specification are listed on an
assembly drawing, it is only necessary to list the assembly drawing.]

.sp 2
.ap
.PP
[The following paragraph must appear now:]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
INTERFACE DESIGN DOCUMENT
.sp
FOR THE
.sp
@SYSNAME

.spaceto -20
.comment
.! The contract number and other information appear here
.comment
CONTRACT NO. [contract number]
.sp
CDRL SEQUENCE NO. [CDRL number]
.sp 2
Prepared for:
.sp
[Contracting Agency Name, department code]
.sp 2
Prepared by:
.sp
[contractor name and address]
.ce off
.sp 2
.nf
.na
.ec \
Accepted by ______________________ Approved by _____________________
(Contracting agency) (Contractor)

Date _____________________________ Date ____________________________
.ec
.fi

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE PRODUCT SPECIFICATION
.sp
FOR THE
.sp
.comment
.! The name of the CSCI appears here
.comment
[CSCI NAME]
.sp
OF
.sp
@SYSNAME

Date _____________________________ Date ____________________________
.ec
.fi

.sp 2
.ul
Drawings
.PP
[Where detailed drawings referred to in a specification are listed on an
assembly drawing, it is only necessary to list the assembly drawing.]

.sp 2
.ap
.PP
[The following paragraph must appear now:]

.comment
.! End of blank page
.comment

.bp 1
.pn arabic A-#
.PP
[Appendixes may be used to provide information published
separately for convenience in document maintenance (e.g., charts,
classified data). As applicable, each appendix shall
be referenced in the main body of the document where the data would
normally have been provided. Appendixes may be bound as separate
documents for ease of handling. Appendixes shall be lettered
alphabetically (A, B, etc.), and the paragraphs within each appendix
be numbered as multiples of 10 (e.g., Appendix A, paragraph 10,
10.1, 10.2, 20, 20.1, 20.2, etc.). Pages within each appendix shall
be numbered alpha-numerically as follows: Appendix A pages shall be numbered
A-1, A-2, A-3, etc. Appendix B pages shall be numbered
B-1, B-2, B-3, etc.]
.PP
[Some liberties have been taken with the appendix lettering scheme
of the DID to make it more consistent with the numbering scheme of
the rest of the sections of this document. The user may wish to change
this if absolute compliance with the DID is required.]
.cl
.SECT 0 A. Software design
.PP
[This appendix shall contain the SDD if that document is not
contained in paragraph 3.1 or in another referenced document. If the
SDD is included herein, the paragraph numbers and page numbers need not
be changed to comply with the requirement stated in 10.2.7 of this DID.]

.comment
.! End of blank page
.comment

.bp 1
.pn arabic B-#
.cl
.SECT 0 B. Source code listings
.PP
[This appendix shall contain the source code listings of the
CSCI if they are not contained in paragraph 3.2.]

.comment
.! End of blank page
.comment

.bp 1
.pn arabic C-#
.cl
.SECT 0 C. Additional appendixes
.PP
[Any additional appendixes shall start with Appendix C.]

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

[Version N: DD MMM YYYY]

.spaceto +15
SOFTWARE DEVELOPMENT PLAN
.sp
FOR THE
.sp
@SYSNAME

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.! The table of contents lists the title and page number of
.! each titled paragraph and subparagraph, figure, table,
.! and appendix, in that order.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
[This paragraph shall contain the approved identification number,
title, and abbreviation, if applicable, of the system to
which this SDP applies. It shall also identify the CSCIs to which the
plan applies. If the SDP applies to all CSCIs in the system,
this shall be stated. If it applies to selected CSCIs, the applicable
CSCIs shall be named by title, abbreviation, and identifier.]
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Document overview
.PP
[This paragraph shall summarize the purpose and contents of this
document.]
.SECT 1 1.4. Relationship to other plans
.PP
[This paragraph shall describe the relationship, if any, of the SDP
to related project management plans.]
.bp
.cl
.SECT 0 2. Referenced documents
.PP
[This section shall list by document number and title all documents
referenced in this document. This section shall also identify
the source for all documents not available through normal Government
stocking activities.]
.bp
.cl
.SECT 0 3. Software development management
.PP
[This section shall be divided into the following paragraphs and subparagraphs
to describe the planning associated with software development management
activities.]
.SECT 1 3.1. Project organization and resources
.PP
[This paragraph shall be divided into the following subparagraphs to
describe the project organization and the project resources of the
contractor.]
.SECT 2 3.1.1. Contractor facilities
.PP
[This subparagraph shall provide a description of the contractor's
facilities to be used for the contracted effort.]
.SECT 2 3.1.2. Government furnished equipment, software, and services
.PP
[This subparagraph shall summarize all Government Furnished Equipment
(GFE), Government Furnished Software (GFS), services, and
facilities required for the contracted effort.]
.SECT 2 3.1.3. Organizational structure
.PP
[This subparagraph shall provide an overview of the contractor's
software project organizational structure.]
.SECT 2 3.1.4. Personnel
.PP
[This subparagraph shall identify the total number of personnel
necessary to complete the software development project.]
.SECT 1 3.2. Schedule and milestones
.SECT 2 3.2.1. Activities
.PP
[This subparagraph shall briefly describe each software development activity
of the project and its associated schedule, based on the contract master
schedule (if applicable).]
.SECT 2 3.2.2. Activity network
.PP
[This subparagraph shall describe the sequential relationship among the
activities of the project.]
.SECT 2 3.2.3. Source identification
.PP
[This subparagraph shall identify and describe the source of the required
resources (software, firmware, and hardware) for the software development
effort.]
.SECT 1 3.3. Risk management
.PP
[This paragraph shall describe the contractor's procedures for managing
areas of risk to successful project completion.]
.SECT 1 3.4. Security
.PP
[This paragraph shall describe the contractor's plans for implementing
the security requirements of this contract.]
.SECT 1 3.5. Interface with associate contractors
.PP
[This paragraph shall describe the contractor's plan for coordinating design
and data management efforts to ensure compatibility at interfaces with
associate contractors (i.e., where two or more contractors are participating
in development or production of the system).]
.SECT 1 3.6. Interface with software IV&V agent(s)
.PP
[This paragraph shall describe the contractor's plans for interfacing with the
software independent verification and validation (IV&V) agent(s), if
applicable.]
.SECT 1 3.7. Subcontractor management
.PP
[This paragraph shall describe the contractor's plans for managing
subcontractors.]
.SECT 1 3.8. Formal reviews
.PP
[This paragraph shall describe the contractor's internal procedures for
preparing for and conducting formal reviews.]
.SECT 1 3.9. Software development library
.PP
[This paragraph shall describe the software development library (SDL)
to be used by the contractor for controlling the software and
associated documentation.]
.SECT 1 3.10. Corrective action process
.PP
[This paragraph shall describe the corrective action process to be
implemented.]
.SECT 1 3.11. Problem/change report
.PP
[This paragraph shall describe the format to be used for problem/change
reports.]
.bp
.cl
.SECT 0 4. Software engineering
.PP
[This section shall be divided into the following paragraphs and
subparagraphs to describe the organization(s) responsible and the
resources necessary for software engineering activities.]
.SECT 1 4.1. Organization and resources - software engineering
.PP
[This paragraph shall describe the organization(s) responsible for
performing the software engineering activities.]
.SECT 2 4.1.1. Organizational structure - software engineering
.PP
[This subparagraph shall describe the organization(s) responsible
for performing the software engineering activities.]
.SECT 2 4.1.2. Personnel - software engineering
.PP
[This subparagraph shall describe the number and skill levels of personnel
who will perform the software engineering activities.]
.SECT 2 4.1.3. Software engineering environment
.PP
[This subparagraph shall be divided into the following subparagraphs to
identify and describe the plans for establishing and maintaining
the resources (software, firmware, and hardware) necessary to perform the
software engineering activities.]
.SECT 3 4.1.3.1. Software items
.PP
[This subparagraph shall identify the software items, such as operating
systems, compilers, code auditors, dynamic path analyzers, test drivers,
preprocessors, test data generators, post-processors, etc., necessary to
perform the software engineering activities.]
.SECT 3 4.1.3.2. Hardware and firmware items
.PP
[This subparagraph shall identify the computer hardware, interfacing
equipment, and firmware items that will be used in the software
engineering environment.]
.SECT 3 4.1.3.3. Proprietary nature and Government rights
.PP
[This subparagraph shall identify the proprietary nature and Government
rights associated with each item of the software engineering
environment.]
.SECT 3 4.1.3.4. Installation, control, and maintenance
.PP
[This subparagraph shall identify the contractor's plans for installing
and testing each item of the software engineering environment prior to use.]
.SECT 1 4.2. Software standards and procedures
.PP
[This paragraph shall be divided into the following subparagraphs to describe
the software standards and procedures the contractor plans to use.]
.SECT 2 4.2.1. Software development techniques and methodologies
.PP
[This subparagraph shall identify and describe the techniques and
methodologies the contractor plans to use to perform software
requirements analysis, preliminary design, detailed design, coding and
CSU testing, CSC integration and testing, and CSCI testing.]
.SECT 2 4.2.2. Software development files
.PP
[This subparagraph shall define the contractor's plans, including the
responsible organization(s), for the creation and maintenance of
software development files (SDFs).]
.SECT 2 4.2.3. Design standards
.PP
[This subparagraph shall describe the design standards the contractor
plans to use in developing the software.]
.SECT 2 4.2.4. Coding standards
.PP
[This subparagraph shall describe the coding standards the contractor
plans to use in developing the software.]
.SECT 1 4.3. Non-developmental software
.PP
[This paragraph shall identify and describe each non-developmental
software item, such as commercially available, reusable, and
Government Furnished Software (GFS), to be incorporated into the
deliverable software.]
.bp
.cl
.SECT 0 5. Formal qualification testing
.PP
[This section shall be divided into the following paragraphs and
subparagraphs to describe the planning associated with formal
qualification testing activities.]
.SECT 1 5.1. Organization and resources - formal qualification testing
.PP
[This paragraph shall be divided into the following subparagraphs
to describe the organization(s) responsible and the resources
necessary for formal qualification testing.]
.SECT 2 5.1.1. Organizational structure - formal qualification testing
.PP
[This subparagraph shall describe the organization(s) responsible
for performing formal qualification testing.]
.SECT 2 5.1.2. Personnel - formal qualification testing
.PP
[This subparagraph shall describe the number and skill levels of
personnel who will perform the formal qualification testing
activities.]
.SECT 1 5.2. Test approach/philosophy
.PP
[This paragraph shall describe the contractor's approach/philosophy for
performing formal qualification testing.]
.SECT 1 5.3. Test planning assumptions and constraints
.PP
[This paragraph shall describe any assumptions that were made in test
planning and any constraints imposed upon formal qualification testing
by the contracting agency.]
.bp
.cl
.SECT 0 6. Software product evaluations
.PP
[This section shall be divided into the following paragraphs
and subparagraphs to describe the planning associated with software
product evaluation activities.]
.SECT 1 6.1. Organization and resources - software product evaluations
.PP
[This paragraph shall be divided into the following subparagraphs to describe
the organization(s) responsible and the resources necessary for software
product evaluations.]
.SECT 2 6.1.1. Organizational structure - software product evaluations
.PP
[This subparagraph shall describe the organization(s) responsible for
performing the software product evaluations.]
.SECT 2 6.1.2. Personnel - software product evaluations
.PP
[This subparagraph shall describe the number and skill levels of personnel
who will perform software product evaluations.]
.SECT 1 6.2. Software product evaluations procedures and tools
.SECT 2 6.2.1. Procedures
.PP
[This subparagraph shall identify and describe the
procedures that will be used to evaluate the software and associated
documentation.]
.SECT 2 6.2.2. Tools
.PP
[This subparagraph shall identify and describe the tools
to be used in the software product evaluations.]
.SECT 1 6.3. Subcontractor products
.PP
[This paragraph shall describe the contractor's plans and procedures for
evaluating the adequacy of requirements established for subcontractors
and for evaluating subcontractor products.]
.SECT 1 6.4. Software product evaluation records
.PP
[This paragraph shall describe the contractor's plans for preparing and
maintaining records of each product evaluation performed.]
.SECT 1 6.5. Activity-dependent product evaluations
.PP
[This paragraph shall be divided into subparagraphs to describe the
contractor's plans for conducting product evaluations of each
software development product.]
.SECT 2 6.5.X. Software products evaluation - [activity name]
.PP
[This subparagraph shall describe the contractor's plans for conducting
evaluations of each of the products of an activity.]
.bp
.cl
.SECT 0 7. Software configuration management
.PP
[This section shall be divided into the following paragraphs and subparagraphs
to describe the planning associated with software configuration management
(CM) activities.]
.SECT 1 7.1. Organization and resources - configuration management
.PP
[This paragraph shall be divided into the following subparagraphs to describe
the organization(s) responsible and the resources necessary for
configuration management.]
.SECT 2 7.1.1. Organizational structure - configuration management
.PP
[This subparagraph shall describe the organization(s) responsible for
performing configuration management.]
.SECT 2 7.1.2. Personnel - configuration management
.PP
[This subparagraph shall describe the number and skill levels of
personnel who will perform configuration management.]
.SECT 1 7.2. Configuration identification
.SECT 2 7.2.1. Developmental configuration identification
.PP
[This subparagraph shall identify the contractor's internal
Developmental Configuration(s) to be used in the development of the
CSCI(s).]
.SECT 2 7.2.2. Identification methods
.PP
[This subparagraph shall describe the methods to be used in identifying
(e.g., naming, marking, numbering) CSCI(s), CSCs, CSUs, and
documentation.]
.SECT 1 7.3. Configuration control
.PP
[This paragraph shall be divided into the following subparagraphs
to provide a detailed description of the procedures to be used in
controlling changes to and maintaining the Developmental
Configuration(s) and internally controlled documentation.]
.SECT 2 7.3.1. Flow of configuration control
.PP
[This subparagraph shall describe the process by which problems and changes are
submitted, reviewed, and subsequently approved or disapproved.]
.SECT 2 7.3.2. Reporting documentation
.PP
[This subparagraph shall be divided into the following subparagraphs
to describe or reference the description of the reporting
documentation, such as Specification Change Notices and Engineering
Change Proposals, to be used in controlling software problems and
changes.]
.SECT 3 7.3.2.X. [Report name]
.PP
[This subparagraph shall describe or reference the format, contents, and
instructions for completing the report.]
.SECT 2 7.3.3. Review procedures
.PP
[This subparagraph shall be divided into the following subparagraphs
to describe the purpose of, and the procedures to be employed by, any
review boards associated with the flow of configuration control.]
.SECT 3 7.3.3.X. [Review board name] procedures
.PP
[This subparagraph shall describe the purpose of and the procedures to be
followed by the review board.]
.SECT 2 7.3.4. Storage, handling, and delivery of project media
.PP
[This subparagraph shall describe the methods and procedures to be used to
formally control the storage, handling, and delivery of deliverable software
and documentation (including master copies) during the development process.]
.SECT 2 7.3.5. Additional control
.PP
[This subparagraph shall identify any additional configuration control
activities not discussed above.]
.SECT 1 7.4. Configuration status accounting
.PP
[This paragraph shall define the configuration status accounting system
to be used.]
.SECT 1 7.5. Configuration audits
.PP
[This paragraph shall describe the contractor's plans for supporting or
conducting configuration audits, as applicable.]
.SECT 1 7.6. Preparation for specification authentication
.PP
[This paragraph shall describe the contractor's procedures to prepare for
and respond to authentication of the applicable specifications.]
.SECT 1 7.7. Configuration management major milestones
.PP
[This paragraph shall identify the major internal and Government milestones
related to software configuration management for the contractual effort.]
.bp
.cl
.SECT 0 8. Other software development functions
.PP
[This section shall be divided into the following paragraphs and
subparagraphs to describe any other contractor functions involved in
the software development effort.]
.SECT 1 8.X. [Function name]
.PP
[This paragraph shall describe a function to be performed.]
.SECT 2 8.X.1. Organizational structure - [function name]
.PP
[This subparagraph shall describe the organization(s) responsible for
performing the function.]
.SECT 2 8.X.2. Personnel - [function name]
.PP
[This subparagraph shall describe the number and skill levels of
personnel who will perform the function.]
.SECT 2 8.X.3. Other resources - [function name]
.PP
[This subparagraph shall identify and describe any other resources necessary
for performing the function.]
.SECT 2 8.X.4. Methods and procedures - [function name]
.PP
[This subparagraph shall describe the methods and procedures to be used
to perform the function.]
.bp
.cl
.SECT 0 9. Notes
.include acronyms.ptf
.PP
[This section shall contain any general information that aids in understanding
this document (e.g., background information, glossary, formula derivations).]

.comment
.! End of blank page
.comment

.comment
.! The table of contents is automatically generated and placed
.! here in the document file. It should be physically moved to
.! after the title page after printing the document.
.comment
.bp 2
.pn lower_roman #
.ce
.ul
Table of Contents
.sp 2
.pc
.comment
.! This is provided in case the table of contents ends on an odd
.! page number.
.comment
.bp
.sp 20
.ce
This page intentionally blank
--::::::::::
--pcr.ptf
--::::::::::
.comment
.! Problem/Change Report as per DoD-STD-2167A
.! This template is compliant with the requirements in the main
.! document of DoD-STD-2167A. This template may be readily altered
.! and still be compliant with DoD-STD-2167A since the guidelines
.! presented in the documentation are very general.
.comment
.vs SYSNAME [Name of System]
.vs DATE [Date of Report]
.vs ID [ID of Report]
.lm 11
.rm 70
.nlheader 3
.he 1 ''Problem/Change Report''
.he 2 /@SYSNAME/@ID/@DATE/
.nlfooter 2
.fo 2 //Page #//
.include header.ptf
.sp 2
.ce on
Problem/Change Report
.sp
for
.sp
@SYSNAME
.ce off
.sp 2
.include pcrbody.ptf
.bp
.sp 20
.ce
This Page Intentionally Blank
.bp 1
.pn arabic A-#
.ce
.ul
Appendix A: Priority Descriptions by Number
.sp 2
.include pcrdesc.ptf
.bp
.sp 20
.ce
This Page Intentionally Blank
.bp 1
.pn arabic Contents-#
.ce on
PCR @ID
on System @SYSNAME
.sp 2
.ul
Table of Contents
.ce off
.sp
.pc
.bp
.sp 20
.ce
This Page Intentionally Blank
--::::::::::
--pcrbody.ptf
--::::::::::
.PCRSTART [Fill in title of PCR here]
.sp 2
.PCRSECT Software System Identification
.nf
System Name: @SYSNAME
Version Number: [Fill in version number here]
Version Date (if known): [Fill in version date here]
.fi
.PCRSECT Identification of Person Reporting Problem
.nf
Name: [Fill in your name here]
Address:
[Fill in your address here.
Take as many lines as needed.]
Electronic Mail: [Fill in your email address here.]
Phone: [Fill in your phone number here.]
.fi
.PCRSECT Problem Classification and Description
.nf
Classification of Problem by Category
(Check all that apply):
Software Problem
Documentation Problem
Design Problem
Classification of Problem by Priority
(Check all that apply, see the 2167A documentation for descriptions):
Priority 1
Priority 2
Priority 3
Priority 4
Priority 5
.fi
.sp 2
.tp 10
.ul
Description of Problem
.PP
[Fill in a complete description of the problem here. Sample inputs
and outputs may be included.]
.PCRSECT Corrective Action
.sp
.ul
Person to whom Corrective Action is assigned
.sp
.nf
[Fill in the name and other identification here.]
.fi
.sp
.ul
Recommended Corrective Action Needed to Resolve Problem
.sp
.PP
[Fill in the corrective action assigned to be performed.]
.sp 2
.ul
Actions Actually Taken to Resolve Problem
.PP
[Fill in the action actually taken to resolve the problem.]
--::::::::::
--pcrdesc.ptf
--::::::::::
1: A software problem that does one of the following:
.br
.li +5
.ri +5
.sp
Prevents the accomplishment of an operational
or mission essential capability specified by
baselined requirements,
.sp
Prevents the operator's
accomplishment of an operational or mission
essential capability, or
.sp
Jeoparidzes personnel
safety.
.li -5
.ri -5
.sp
2: A software problem that does one of the following:
.br
.li +5
.ri +5
.sp
Adversely affects the operator's accomplishment
of an operational or mission essential
capability specified by baselined requirements
so as to degrade performance and for which no
alternative work-around solution is known or
.sp
Adversely affects the operator's accomplishment
of an operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which no alternative
work-around solution is known.
.li -5
.ri -5
.sp
3: A software problem that does one of the following:
.br
.li +5
.ri +5
.sp
Adversely affects the accomplishment of an
operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which an alternative
work-around solution is known or
.sp
Adversely
affects the operator's accomplishment of an
operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which an alternative
work-around solution is known.
.li -5
.ri -5
.sp
4: A software problem that is an operator inconvenience
or annoyance and which does not affect a required
operational or mission essential capability
.sp
5: All other errors
.br
--::::::::::
--diddoc.inc
--::::::::::
acronyms.ptf
didsum.ptf
didvdd.ptf
header.ptf
overview.ptf
pcr001.ptf
pcrdesc.ptf
--::::::::::
--diddoc.src
--::::::::::
--::::::::::
--acronyms.ptf
--::::::::::
.comment
.! This include file contains a table of acronyms which is used
.! in many of the DoD-STD-2167A documents.
.comment
.sp 2
.ce
.ul
Acronyms
.sp 1
.nf
.na
.need 24
.ul
Acronym Meaning
ASR Ada Software Repository
CDR Criticial Design Review
CDRL Contract Data Requirements List
CIDS Critical Item Development Specification
CRISD Computer Resources Integrated Support Document
CSC Computer Software Component
CSCI Computer Software Configuration Item
CSOM Computer System Operator's Manual
CSU Computer Software Unit
DID Data Item Description
DOD Department of Defense
DODISS Department of Defense Index of Specifications
and Standards
ECP Engineering Change Proposal
FAR Gederal Acquisition Regulation
FCA Functional Configuration Audit
FSM Firmware Support Manual
FQT Formal Qualification Testing
GFE Government Furnished Equipment
GFI Government Furnished Information
GFS Government Furnished Software

.need 14
.ul
Acronym Meaning
HOL High Order Language
HWCI Hardware Configuration Item
ICD Interface Control Document
IDD Interface Design Document
I/O Input/Output
IRS Interface Requirements Specification
IV&V Independent Verification and Validation
NDS Non-development Software
PCA Physical Configuration Audit
PCR Problem/Change Report
PDR Preliminary Design Review
PIDS Prime Item Development Specification
PTF Portable Text Formatter

.need 5
.ul
Acronym Meaning
TRR Test Readiness Review
VDD Version Description Document
WBS Work Breakdown Structure
.fi
.comment
.! The user may wish to add the following .ap command
.! if auto-paragraphing is desired at this point in the document.
.comment
.! .ap
--::::::::::
--didsum.ptf
--::::::::::
.comment
.! Software User's Manual (2167A, DI-MCCR-80019A) for:
.! Collection of DoD-STD-2167A DID TEMPLATES for PTF
.! Prepared by: Richard Conn
.! Date: 15 May 1990
.!
.! Description and Purpose:
.! 1. The Software User's Manual (SUM) provides user personnel
.! with instructions sufficient to execute one or more related
.! Computer Software Configuration Items (CSCIs).
.! 2. The SUM provides the steps for executing the software, the
.! expected output, and the measures to be taken if error messages
.! appear.
.! 3. The information required by this DID (Data Item Descriptor)
.! is directed to the functional user of the CSCI(s), as opposed
.! to the operator of the computer system. If this distinction does
.! not exist, the user will need to refer to both the Computer
.! System Operator's Manual and the SUM to operate the computer system
.! and to use the CSCI(s).
.!
.! Tailoring Instructions:
.! To tailor this template, fill in the areas surrounded by
.! [] as indicated.
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

Version 2: 15 May 1990

.spaceto +15
SOFTWARE USER'S MANUAL
.sp
FOR THE
.sp
@SYSNAME

.spaceto -20
.comment
.! The contract number and other information appear here
.comment
CONTRACT NO. None
.sp
CDRL SEQUENCE NO. None
.sp 2
Prepared for:
.sp
Users of the Ada Software Repository
SIMTEL20 Host Computer
White Sands Missile Range, New Mexico 88002
.sp 2
Prepared by:
.sp
Richard Conn
Manager, Ada Software Repository

.ce off

.comment
.! This document is referenced frequently, so I have
.! defined it here as a macro for convenience.
.comment
.de PTFSUM
.ul
Software User's Manual for the Portable Text Formatter
.en

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
This
.ul
Software User's Manual
(SUM) applies to Version 2 of the collection of DoD-STD-2167A
DID template files
for processing by the Portable Text Formatter (PTF).
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Document overview
.PP
This SUM contains instructions on tailoring and editing the
DID template files and instructions on running PTF
to process the edited DID template files.
.bp
.cl
.SECT 0 2. Referenced documents
.PP
Ada Software Repository,
.ul
Portable Text Formatter
(PTF) documentation set,
PD2:<ADA.WORD__PROCESSORS> subdirectory (at the time of this writing -
subject to change)
.PP
Ada Software Repository,
.ul
Proposed MIL-HDBK-1804 (Ada Style Guide),
PD2:<ADA.DOCUMENTS> subdirectory (at the time of this writing - subject
to change)
.PP
Ada Software Repository,
.PTFSUM
(part of the PTF documentation set)
.PP
United States Department of Defense,
.ul
Military Standard Defense System Software Development,
DOD-STD-2167A, 29 February 1988
.bp
.cl
.SECT 0 3. Execution procedures
.PP
This section presents a method for using this
system of DoD-STD-2167A DID templates for the preparation of the
deliverable documents. An understanding of the Portable Text Formatter (PTF)
and its use is assumed.
.PP
The following steps are recommended by this method for DoD-STD-2167A
documentation generation:
.li +2
.LIST 4
.LE Create an empty working directory
.LE Copy all the DID template files into it
.PP
This system should be copied into the working directory in its entirety.
The common files and the DID template files will all be available to the
user.
.LE Delete all unneeded DID template files
.PP
This step removes the DID template files for the documents which
are not to be produced. Clutter in the working directory is reduced.
.LE Edit the common template files
.PP
The common template files set the name of the system (through the SYSNAME
variable), the length of the lines (through global left and right
margin setting commands), and the text of the overview of the system
which will be incorporated into many of the deliverable documents.
They are listed in Appendix A.
.LE Tailor the DID template files
.PP
Some sections or paragraphs may be omitted or unneeded, some
multiple-paragraph
groups may have to be planned (such as the group of paragraphs describing
each CSC, for example), and some customer directive may specify
certain ways to tailor the DIDs.
.LE Edit the DID template files
.PP
Fill in the required information.
.LE Format the DID template files using PTF
.LE Print and review the deliverable documents
.PP
An iteration of the last few steps may be necessary before the deliverable
documents have the desired appearance.
.ELIST
.li -2
.SECT 1 3.1. Editing the Common Template Files
.PP
The first major action on the distribution files of
.ul
@SYSNAME
is to edit the common template files. There are three common template
files (header.ptf, overview.ptf, and acronyms.ptf), and they are listed
in Appendix A. The reader may wish to refer to them while reading this
section.
.PP
The file
.ul
header.ptf
defines three sets of information: (1) the name of the system,
which is stored in the variable SYSNAME, (2) the left and right margins
of the document, and (3) a set of useful macros. The variable SYSNAME
is used extensively throughout the DoD-STD-2167A DID templates, and it
contains the name of the system referenced by the DIDs. The left and
right margins should be set for the desired margins and line length;
the distribution sets these at 11 and 70, which gives a 60-character
line length for PICA type. The setting for ELITE type is 13 and 90,
giving a 78-character line length. The macros are discussed in the next
section (Section 3.2).
.PP
The file
.ul
acronyms.ptf
defines commonly-used acronyms in the documents. Note that the
acronym listing in this file is broken into groups so that any particular
group will appear with its header intact on a page. The user may or may
not choose to follow this convention. Also, it is intended that this
file contain all acronyms used in every deliverable document so that
it can be reused without the user having to worry about not covering
any particular acronym.
.PP
The file
.ul
overview.ptf
is a concise description of the system to which the DIDs apply.
It is inserted into virtually every deliverable document, and placing
this description into a separate file eliminates a lot of duplication
and provides a common point for modification.
.SECT 1 3.2. Using the Macros in the File header.ptf
.PP
The following groups of macros are defined in the
.ul
header.ptf
file:
.sp
.nf
.ul
Group Macro Name Comment

1 SECT Define a new section

2 LIST Start a list of items
LE Define a list item
ELIST End a list of items

3 SLIST Start a sublist of items
SLE Define a sublist item
ESLIST End a sublist of items

4 PP Start a new paragraph

5 FIG Define a figure
PRFIG Print the list of figures

6 TAB Define a table
PRTAB Print the list of tables

7 PCRSTART Start a new PCR
PCRSECT Start a new section of a PCR
.fi
.PP
Each macro is described below.
.SECT 2 3.2.1. SECT Macro
.PP
The general format of the SECT macro is:
.sp
.ce
SECT <identation level> <number> <text>
.PP
SECT is used to define a new section of the document. SECT places an
entry into the table of contents and places a left-justified
underlined title on the
current page. Two blank lines are placed before the section
title in the document, and a test is performed (with a page eject
if the test fails) to see if 10 lines remain on the page.
The SECT macro requires
three parameters:
.li +5
.LIST 4
.LE <indentation level>
.PP
This is a number from 0 on up which indicates the number of three-space
groups to place before the entry in the table of contents. For instance,
an <indentation level> of 0 places no spaces before the entry, 1 places
three spaces, 2 places six spaces, etc.
.LE <number>
.PP
This is the number of the section. It must not contain any spaces.
This number will appear in both the table of contents and the body of
the document, but, unlike the <text> of the section, it will not be
underlined in the body.
.LE <text>
.PP
This is the text to appear as the title of the section. It will appear
in both the table of contents and the body of the document, and it will
be underlined in the body of the document.
.ELIST
.li -5
.PP
The following are examples of the use of the SECT macro:
.li +5
.LIST 4
.LE Example 1 (.SECT 1 2.2. Examples of SECT)
.PP
This example places the following text (between the quotes) into the
table of contents (# is the page number, and there may be more or less
dots, depending on the line length). Note the three leading spaces:
.sp
.nf
" 2.2. Examples of SECT . . . . . #"
.fi
.PP
This example also places the following text (between the quotes) into
the document, left-justified against the left margin:
.sp
.ti +2
"2.2.
.ul
Examples of SECT
"
.LE Example 2 (.SECT 0 1. Introduction)
.PP
This example places the following text (between the quotes) into the
table of contents (# is the page number, and there may be more or less
dots, depending on the line length). Note that there are no leading
spaces:
.sp
.nf
"1. Introduction . . . . . . . . . . . #"
.fi
.PP
This example also places the following text (between the quotes) into
the document, left-justified against the left margin:
.sp
.ti +2
"1.
.ul
Introduction
"
.ELIST
.li -5
.SECT 2 3.2.2. LIST Macro
.PP
The LIST macro defines the start of a new list of items.
Its one argument is the number of spaces (both left and right)
to indent the list. This macro sets the indentation (left and right)
and zeroes the number register used to number the list items.
.PP
The following text fragment shows the use of the three macros (LIST, LE,
and ELIST) to create a list of items:
.sp
.nf
.LIST 4
.LE This is the first item.
These lines supplement the description of the first item.
.LE This is the second item.
These lines supplement the description of the second item.
.ELIST
.fi
.PP
The above list appears as follows:
.sp
.LIST 4
.LE This is the first item.
These lines supplement the description of the first item.
.LE This is the second item.
These lines supplement the description of the second item.
.ELIST
.sp
.SECT 2 3.2.3. LE Macro
.PP
The LE macro defines an item in a list. Each list item is preceeded by
a blank line, a list element number, a period, and the text part of
the ".LE <text>" macro call. The line generated by the LE macro is
indented to the left by the number of spaces given in the LIST macro;
all other lines following the LE macro are right and left justified within
the bounds set by the LIST macro. See Section 3.2.2 for an example of the
use of the LE macro.
.SECT 2 3.2.4. ELIST Macro
.PP
The ELIST macro ends a list of items. The indentation set by the LIST
macro is cleared, and a break is issued. See Section 3.2.2 for an example
of the use of the ELIST macro.
.SECT 2 3.2.5. SLIST Macro
.PP
The SLIST macro and its associated macros (SLE and ESLIST) allow the
user to place a sublist within a list. Like the LIST macro, the SLIST
macro requires one argument which specifies the number of spaces to
indent on both the right and the left sides. This is in addition to
the indentation already being performed as a result
of the outer LIST macro. The SLIST macro also zeroes a second number
register which is used to number the sublist elements.
.PP
The following text fragment shows the use of the three macros (SLIST, SLE,
and ESLIST) to create a sublist of items within a list:
.sp
.nf
.LIST 4
.LE This is the first item.
These lines supplement the description of the first item.
.SLIST 4
.SLE This is the first sublist's first item.
.SLE This is the first sublists's second item.
.ESLIST
.LE This is the second item.
.SLIST 4
.SLE This is the second sublist's first item.
.SLE This is the second sublist's second item.
.ESLIST
These lines supplement the description of the second item.
.ELIST
.fi
.PP
The following text fragment shows the use of these six macros (LIST, LE,
ELIST, SLIST, SLE, and ESLIST) to create a list of items:
.sp
.LIST 4
.LE This is the first item.
These lines supplement the description of the first item.
.SLIST 4
.SLE This is the first sublist's first item.
.SLE This is the first sublists's second item.
.ESLIST
.LE This is the second item.
.SLIST 4
.SLE This is the second sublist's first item.
.SLE This is the second sublist's second item.
.ESLIST
These lines supplement the description of the second item.
.ELIST
.sp
.SECT 2 3.2.6. SLE Macro
.PP
The SLE macro defines an item in a sublist. Each sublist item is preceeded
by
a blank line, a list element number, a period, a sublist element
number, a period, and the text part of
the ".SLE <text>" macro call. The line generated by the SLE macro is
indented to the left by the number of spaces given in the SLIST macro;
all other lines following the SLE macro are right and left justified within
the bounds set by the SLIST macro. See Section 3.2.5 for an example of the
use of the SLE macro.
.SECT 2 3.2.7. ESLIST Macro
.PP
The ESLIST macro ends a sublist of items. The indentation set by the SLIST
macro is cleared, and a break is issued. See Section 3.2.5 for an example
of the use of the ESLIST macro.
.SECT 2 3.2.8. PP Macro
.PP
The PP macro starts a new paragraph. A blank line is generated, and the
text which starts on the line following the ".PP" macro call is indented
by five spaces.
.SECT 2 3.2.9. FIG Macro
.PP
The FIG macro is used to place the heading for a figure on the page
and make an entry into the list of figures. The FIG macro call is of
the form:
.sp
.nf
.FIG <indentation level> <text>
.fi
.PP
The <indentation level> parameter indicates the number of groups of
three spaces to indent the entry in the list of figures. The <text>
contains the title of the figure. No numbering is assumed, so if
a list of numbered figures is desired, the number must be placed into
the FIG macro call explicitly (e.g., 1) or implicitly (e.g., by using
number registers, like _@nf). The phrase
.sp
.nf
Figure <text>
.fi
.sp
will appear centered and underlined in the document at the point of
the FIG macro call.
.SECT 2 3.2.10. PRFIG Macro
.PP
The PRFIG macro is used to print the list of figures. PRFIG will cause
a page break, the title "List of Figures" to be centered and underlined,
two blank lines, and the list of all figures defined so far. The list
of figures accumulated to date will be cleared after the PRFIG macro
completes its function, so PRFIG may be used only once.
.SECT 2 3.2.11. TAB Macro
.PP
The TAB macro is used to place the heading for a table on the page
and make an entry into the list of tables. Like the FIG
macro call, the TAB macro call is of
the form:
.sp
.nf
.TAB <indentation level> <text>
.fi
.PP
The <indentation level> parameter indicates the number of groups of
three spaces to indent the entry in the list of tables. The <text>
contains the title of the table. No numbering is assumed, so if
a list of numbered tables is desired, the number must be placed into
the TAB macro call explicitly (e.g., 1) or implicitly (e.g., by using
number registers, like _@nf). The phrase
.sp
.nf
Table <text>
.fi
.sp
will appear centered and underlined in the document at the point of
the TAB macro call.
.SECT 2 3.2.12. PRTAB Macro
.PP
The PRTAB macro is used to print the list of tables. PRTAB will cause
a page break, the title "List of Tables" to be centered and underlined,
two blank lines, and the list of all tables defined so far. The list
of tables accumulated to date will be cleared after the PRTAB macro
completes its function, so PRTAB may be used only once.
.SECT 2 3.2.13. PCRSTART Macro
.PP
The PCRSTART macro is used to start a new Problem/Change Report (PCR).
PCRSTART will cause the number register p to be set to zero,
a contents line, at indentation level 2, to be placed into the table
of contents, and a title line to be placed into the PCR. No blank lines
are added, so the user may wish to follow a PCRSTART macro with an .sp 2
command or the like.
.PP
The syntax of the PCRSTART macro is:
.sp
.nf
.PCRSTART <title of PCR>
.fi
.PP
See the Section 3.3 for more discussion of PCRs.
.SECT 2 3.2.14. PCRSECT Macro
.PP
The PCRSECT macro is used to start a new section in a Problem/Change Report
(PCR). The
number register p is incremented and used as the section number.
.PP
The syntax of the PCRSECT macro is:
.sp
.nf
.PCRSECT <title of PCR section>
.fi
.PP
See the Section 3.3 for more discussion of PCRs.
.SECT 1 3.3. Editing the DID Template Files
.PP
Each DID template file is ready for processing by PTF as distributed.
If the user makes no modifications to the template at all, PTF will produce
a deliverable document that shows the structure of the DID as a whole
and contains explanatory comments enclosed in square brackets. The first
time that
.ul
@SYSNAME
is used, the user may wish to run PTF on some raw DID template files to
get a feeling of what the resulting deliverable documents will look like.
.PP
Once the common template files documented in
Section 3.2 are prepared, the groundwork is laid
for preparing the 17 DID templates files. Each DID template file
reads in the common
template files at the appropriate point in the DID template and provides
the facilities of the common template file (in the case of the header.ptf
file) or the text of the common template file (in the case of the
acronyms.ptf and overview.ptf files). Filling in
the rest of the DID template file is a matter of reading the DID template
and replacing all areas of the template which are surrounded by square
brackets ([]) with the text. The areas surrounded by the square brackets
contain instructions which explain the information to enter in their
place. The user may have to refer to the actual DoD-STD-2167A DID
for further elaboration.
.PP
The files PCRBODY.PTF and PCRDESC.PTF are used as templates for creating
a number of Problem/Change Reports (PCRs). At the user's discretion,
PCRs may be generated standalone using the PCR.PTF file or may be
incorporated into a Version Description Document's appendix via the file
VDD.PTF. The idea is to create a new version of PCRBODY.PTF for
each PCR, each version of PCRBODY.PTF having a different name
(e.g., PCR001.PTF).
.PP
For example, the following shows sections 3.5 to 3.7 of the
.ul
Version Description Document
DID. Note the explanatory comments enclosed in the square
brackets.
.sp
.nf
.cc \
.SECT 1 3.5. Adaptation data
.PP
[For the initial release of a CSCI, this paragraph shall identify
or reference all unique-to-site data contained in the items being
delivered. For subsequent CSCI versions, this paragraph shall contain
the information necessary to identify changes made to the
adaptation data.]
.SECT 1 3.6. Interface compatibility
.PP
[This paragraph shall indicate other systems and configuration items
affected by the changes incorporated in this version. Note: This
paragraph does not apply to the initial version of a CSCI.]
.SECT 1 3.7. Bibliography of reference documents
.PP
[For the initial version of a CSCI, this paragraph shall list
all documents pertinent to the CSCI. For subsequent CSCI versions,
this paragraph shall identify changes to the listed documents.]
\cc
.fi
.PP
In processing these sections of the DID template file, the user would
read the comments in the square brackets, enter the text as required,
and then delete the comments in the square brackets.
.SECT 1 3.4. Running PTF to Produce the Deliverable Documents
.PP
PTF is run on the DID template files to produce the deliverable
documents. See the
.PTFSUM
for complete details on its use. Simply put, the DID template files
are processed by PTF command lines of the following format:
.sp
.ce
PTF <DID template file name> <output file name>
.sp
For example,
.sp
.nf
ptf vdd.ptf vdd.doc
ptf sum.ptf sum.doc
.fi
.bp
.cl
.SECT 0 4. Error messages
.PP
Not applicable for this system. See the
.PTFSUM
for error messages generated by the Portable Text Formatter.
.bp
.cl
.SECT 0 5. Notes
.SECT 1 5.1. Acronyms
.include acronyms.ptf
.sp 2
.SECT 1 5.2. Definitions of Terms Used in this Document
.sp 2
.PP
.ul
common files
or
.ul
common template files
- files read by more than one of the
.ul
DID template files
that provide text that is repeated in the deliverable documents;
the
.ul
common template files
delivered with this version of
.ul
@SYSNAME
are listed in Appendix A
.PP
.ul
deliverable documents
- documents which are described by the DoD-STD-2167A DIDs and are to
be delivered to the customer; the DIDs for these documents are called
out on the CDRL
.PP
.ul
DID template files
- the files delivered with this system which, when processed by PTF,
create the deliverable documents
.comment
.! This appends a blank page to the end of a main body or
.! appendix of the document. This blank page may be removed
.! if it is numbered odd or retained if it is even.
.comment
.bp
.sp 20
.ce
This page intentionally blank

.comment
.! End of blank page
.comment

.bp 1
.pn arabic A-#
.cl
.SECT 0 A. Listings of Common Files Used by the DID Templates
.PP
This appendix contains listings of the common files used by the DID
templates. It may be convenient to refer to these listings during
the reading of this
.ul
Software User's Manual.
.sp 2
.SECT 1 A.1. Listing of File header.ptf
.sp 2
.nf
.cc \
\fc ~
\ec `
.comment
.! Enter the name of the system below
.comment
.vs SYSNAME [SYSTEM NAME]

.comment
.! Useful Macros (note that macros are in upper-case):
.!
.! .SECT <indentation level> <number> <text>
.! -- define a section which appears in the document and the
.! -- table of contents
.!
.! .LIST <number of spaces to indent>
.! -- start a list of items; the list will be indented from the
.! -- right and left by the indicated number of spaces;
.! -- nothing is output by this macro -- only the indentation
.! -- is changed and the number of the next list element
.! -- is set
.!
.! .LE <text>
.! -- enter a new list item into the list; this may be
.! -- followed by more lines containing text associated
.! -- with the list entry; a blank line is generated followed
.! -- by a list element number, a period, and <text> extended
.! -- to the left by the <number of spaces to indent> set by
.! -- the .LIST macro
.!
.! .ELIST
.! -- end a list of items; the indentation set by .LIST is
.! -- unset; a break is issued
.!
.! .SLIST <number of spaces to indent>
.! -- start a sublist of items while in a list; the sublist will
.! -- be further indented from the right and left by the
.! -- indicated number of spaces
.!
.! .SLE <text>
.! -- enter a new list item into the sublist; this may be
.! -- followed by more lines containing text associated
.! -- with the sublist entry; a blank line is generated
.! -- followed by N.M (N=list element number, M=sublist number),
.! -- a period, and <text> extended to the left by the
.! -- <number of spaces to indent> set by the .SLIST macro
.!
.! .ESLIST
.! -- end a sublist of items and continue with the list
.!
.! .PP
.! -- skip a line and start a new paragraph, indented by 5
.! -- spaces
.!
.! .FIG <indentation level> <text>
.! -- enter a figure into the "List of Figures"
.!
.! .PRFIG
.! -- print the "List of Figures"
.!
.! .TAB <indentation level> <text>
.! -- enter a table into the "List of Tables"
.!
.! .PRTAB
.! -- print the "List of Tables"
.!
.! .PCRSTART <title text>
.! -- start a new Problem/Change Report
.!
.! .PCRSECT <section title text>
.! -- start a new section in a Problem/Change Report
.!
.comment

.comment
.! End of blank page
.comment

.ce on

.comment
.! The next line contains the revision indicator and the
.! date of revision.
.comment

Version 2: 15 May 1990

.spaceto +15
VERSION DESCRIPTION DOCUMENT
.sp
FOR THE
.sp
.comment
.! The name of the CSCI appears here
.comment
@SYSNAME

.spaceto -20
.comment
.! The contract number and other information appear here
.comment
CONTRACT NO. None
.sp
CDRL SEQUENCE NO. None
.sp 2
Prepared for:
.sp
Users of the Ada Software Repository
SIMTEL20 Host Computer
White Sands Missile Range, New Mexico
.sp 2
Prepared by:
.sp
Richard Conn
Manager, Ada Software Repository

.ce off

.comment
.! The next page starts with the Scope and is numbered 1.
.! The table of contents is created at the end of the PTF
.! output file and should be inserted after this title page.
.comment
.bp 1
.fo //#//
.cl
.SECT 0 1. Scope
.SECT 1 1.1. Identification
.PP
This
.ul
Version Description Document
(VDD) applies to Version 2 of the collection of DoD-STD-2167A DID template
files for processing by the Portable Text Formatter (PTF).
.SECT 1 1.2. System overview
.include overview.ptf
.SECT 1 1.3. Documentation overview
.PP
This VDD contains documentation on the files associated with this release,
and, when a released file is composed of several component files, this
VDD identifies and describes these component files as well.
.bp
.cl
.SECT 0 2. Referenced documents
.PP
Ada Software Repository,
.ul
PAGER2
tool and documentation set, PD2:<ADA.PAGER> subdirectory
(at the time of this writing - subject to change)
.PP
Ada Software Repository,
.ul
Portable Text Formatter
(PTF) documentation set, PD2:<ADA.WORD__PROCESSORS> subdirectory
(at the time of this writing - subject to change)
.PP
Ada Software Repository,
.ul
Software User's Manual for the @SYSNAME,
PD2:<ADA.DOD-STD-2167A> subdirectory (at the time of this writing - subject
to change)
.PP
United States Department of Defense,
.ul
Military Standard Defense System Software Development,
DOD-STD-2167A, 29 February 1988
.bp
.cl
.SECT 0 3. Version description
.SECT 1 3.1. Inventory of materials released
.PP
Six files comprise this distribution:
.sp
.nf
.ul
File Name Description
did2167a.src Collection of template files
did2167a.inc Listing of files in did2167a.src
did2167a.pro Ada Software Repository Prologue
didsum.doc Formatted Software User's Manual
for this system
didvdd.doc Formatted Version Description Document
for this system
diddoc.src PTF sources for the Software User's
Manual and the Version Description
Document
.fi
.PP
The files DIDVDD.DOC and DIDSUM.DOC are formatted documents which
describe this distribution and how to use this system.
.SECT 1 3.2. Inventory of CSCI contents
.PP
The file DID2167A.SRC contains:
.sp
.nf
.need 6
.ul
Common Template Files

.ul
File Name Description
acronyms.ptf List of acronyms
header.ptf Header (with layout and SYSNAME info)
overview.ptf Overview of system

.need 42
.ul
Template Files of Deliverable Documents

.ul
File Name Description
sss.ptf System/Segment Specification
DI-CMAN-80008A
ssdd.ptf System/Segment Design Document
DI-CMAN-80534
sdd.ptf Software Design Document
DI-MCCR-80012A
vdd.ptf Version Description Document
DI-MCCR-80013A
stp.ptf Software Test Plan
DI-MCCR-80014A
std.ptf Software Test Description
DI-MCCR-80015A
str.ptf Software Test Report
DI-MCCR-80017A
csom.ptf Computer System Operator's Manual
DI-MCCR-80018A
sum.ptf Software User's Manual
DI-MCCR-80019A
spm.ptf Software Programmer's Manual
DI-MCCR-80021A
fsm.ptf Firmware Support Manual
DI-MCCR-80022A
crisd.ptf Computer Resources Integrated Support
Document
DI-MCCR-80024A
srs.ptf Software Requirements Specification
DI-MCCR-80025A
irs.ptf Interface Requirements Specification
DI-MCCR-80026A
idd.ptf Interface Design Document
DI-MCCR-80027A
sps.ptf Software Product Specification
DI-MCCR-80029A
sdp.ptf Software Development Plan
DI-MCCR-80030A
pcr.ptf Standalone Problem/Change Report
pcrbody.ptf Reusable Problem/Change Report Template
pcrdesc.ptf PCR Priority Classifications
.fi
.SECT 1 3.3. Class I changes installed
.PP
None.
.SECT 1 3.4. Class II changes installed
.PP
None. However, one Priority 4 change has been installed.
See Appendix A for a description of it.
.SECT 1 3.5. Adaptation data
.PP
No adaptation is required as the computing environment changes.
This system depends upon the proper installation of the PTF
program. See Section 3.5 of the
.ul
Version Description Document for the Portable Text Formatter
for details on the adaptation of PTF.
.SECT 1 3.6. Interface compatibility
.PP
Not applicable.
.SECT 1 3.7. Bibliography of reference documents
.PP
Ada Software Repository,
.ul
PAGER2
tool and documentation set, PD2:<ADA.PAGER> subdirectory
(at the time of this writing - subject to change)
.PP
Ada Software Repository,
.ul
Portable Text Formatter
(PTF) documentation set, PD2:<ADA.WORD__PROCESSORS> subdirectory
(at the time of this writing - subject to change)
.PP
Ada Software Repository,
.ul
Software User's Manual for the @SYSNAME,
PD2:<ADA.DOD-STD-2167A> subdirectory (at the time of this writing - subject
to change)
.SECT 1 3.8. Summary of change
.PP
See Appendix A for details.
.SECT 1 3.9. Installation instructions
.PP
1. Copy the file DID2167A.SRC into an empty working directory.
.PP
2. Break down
this file into each of its component files (listed in Section 3.2 above).
The PAGER2 tool from the Ada Software Repository may be used to do this
by issuing the following command:
.sp
.ce
pager2 u did2167a.src
.sp
If PAGER2 is not available or has not been installed on your system,
a conventional text editor (which can handle large ASCII files) can be
used to edit DID2167A.SRC and extract each of the component files
manually. Each component file is prefixed by a PAGER2 banner of the form:
.sp
.nf
--::::::::::
--filename
--::::::::::
.fi
.sp
.SECT 1 3.10. Possible problems and known errors
.PP
There are no known errors with this system. Problems encountered
are usually due to problems in using the PTF program, and this information
is detailed in the PTF documentation set.
.bp
.cl
.SECT 0 4. Notes
.include acronyms.ptf

.comment
.! End of blank page
.comment

.bp 1
.pn arabic A-#
.cl
.SECT 0 A. Problem/Change Reports
.sp 2
.include pcr001.ptf
.bp
.sp 20
.ce
This Page Intentionally Blank

.bp 1
.pn arabic B-#
.cl
.SECT 0 B. Problem/Change Report Priority Classification
.sp 2
.include pcrdesc.ptf
.bp
.sp 20
.ce
This Page Intentionally Blank

.! ------------------------------------------------
.define SECT
.contline @1 @2 @3 @4 @5 @6 @7 @8 @9
.sp 2
.ne 10
@2
.ul
@3 @4 @5 @6 @7 @8 @9
.br
.en
.! ------------------------------------------------
.define LIST
.vs LISTINDENT @1
.li +@LISTINDENT
.ri +@LISTINDENT
.nr a 0
.en
.! ------------------------------------------------
.define LE
.sp
.ti -@LISTINDENT
.nr a +1
@na.
@1 @2 @3 @4 @5 @6 @7 @8 @9
.br
.en
.! ------------------------------------------------
.define ELIST
.br
.li -@LISTINDENT
.ri -@LISTINDENT
.en
.! ------------------------------------------------
.define SLIST
.vs SLISTINDENT @1
.li +@SLISTINDENT
.ri +@SLISTINDENT
.nr b 0
.en
.! ------------------------------------------------
.define SLE
.sp
.ti -@SLISTINDENT
.nr b +1
@na.@nb.
@1 @2 @3 @4 @5 @6 @7 @8 @9
.br
.en
.! ------------------------------------------------
.define ESLIST
.br
.li -@SLISTINDENT
.ri -@SLISTINDENT
.en
.! ------------------------------------------------
.define PP
.sp
.ti +5
.en
.! ------------------------------------------------
.define FIG
.contsel 1
.cl @1 @2 @3 @4 @5 @6 @7 @8 @9
.ul
.ce
Figure @2 @3 @4 @5 @6 @7 @8 @9
.contsel
.en
.! ------------------------------------------------
.define PRFIG
.contsel 1
.bp
.ce
.ul
List of Figures
.sp 2
.pc
.contsel
.en
.! ------------------------------------------------
.define TAB
.contsel 2
.cl @1 @2 @3 @4 @5 @6 @7 @8 @9
.ul
.ce
Table @2 @3 @4 @5 @6 @7 @8 @9
.contsel
.en
.! ------------------------------------------------
.define PRTAB
.contsel 2
.bp
.ce
.ul
List of Tables
.sp 2
.pc
.contsel
.en
.! ------------------------------------------------
.define PCRSTART
.tp 10
.contline 2 @1 @2 @3 @4 @5 @6 @7 @8 @9
PCR:
.ul
@1 @2 @3 @4 @5 @6 @7 @8 @9
.br
.nr p 0
.en
.! ------------------------------------------------
.define PCRSECT
.sp 2
.tp 10
------------------------------------------------------------
.nr p +1
Section @np --
.ul
@1 @2 @3 @4 @5 @6 @7 @8 @9
.sp
.en
--::::::::::
--overview.ptf
--::::::::::
.comment
.! This is a system overview, which is common to many
.! of the DoD-STD-2167A DIDs.
.comment
.PP
This system is a collection of templates for all the
Data Item Descriptors (DIDs) documented in DoD-STD-2167A.
These templates are to be edited and tailored by the user for
his specific project. They contain instructions to the user,
telling him what items of information to insert at various
points in the template. The user replaces these instructions with
the information itself, transforming the template into the document.
Once the tailoring is complete and all items required by the DID are
filled in by the user, the user may then execute the Portable Text
Formatter (PTF) to process the edited template into the formatted
deliverable document. The required section numbering, page numbering,
headers, table of contents, list of figures, list of tables, and
index will be generated automatically by PTF in the format required
by the DID.
.PP
This system consists of two sets of files: (1) the common files,
which are filled in once by the user and are then read by the templates
during their processing by PTF, and (2) the DID templates themselves,
where each DoD-STD-2167A DID maps to one of the DID templates. The
common files provide information, such as the name of the system,
an overview of the system, and a list of acronyms, which are needed by
all or most of the DID templates. The common files eliminate duplication
of effort on the part of the user by putting information needed by one
or more DID in a common location that can be read by the template.
The DID templates contain all the PTF commands and instructions to the
user for their use. The user instructions are always enclosed in square
brackets ([]), and, as the user works with a template, he can read the
instructions, input the required information, and then delete everything
within the square brackets as he goes. The instructions in the square
brackets are, in effect, replaced by the information of the DID itself.
In some cases, the DID templates are stand-alone; the user does not
need to refer to the DoD-STD-2167A DID to fill out the template.
In other cases, the DID template refers to the DoD-STD-2167A DID for
more information.
.PP
The documentation provided with this system is a
.ul
Software User's Manual
(DID DI-MCCR-80019A) and a
.ul
Version Description Document
(DID DI-MCCR-80013A). This documentation was prepared as outlined
above from the respective DID templates and provides a living example
of this system in action.
Other examples of this system in action can be found in the Ada Software
Repository (ASR) in the Proposed MIL-HDBK-1804 documents and in the
documentation for the Portable Text Formatter (PTF).
.PP
This system represents an interpretation of the DoD-STD-2167A document and
its DIDs, and, while great care was taken to be correct, errors may have
been introduced. Please report any such errors to the Manager, Ada Software
Repository. This system is a project of the Ada Software Repository
activity at White Sands and is not necessarily endorsed by the United States
Department of Defense as an official representation of DoD-STD-2167A.
--::::::::::
--pcr001.ptf
--::::::::::
.PCRSTART Add PCR Files
.sp 2
.PCRSECT Software System Identification
.nf
System Name: @SYSNAME
Version Number: 1
Version Date (if known): 21 September 1989
.fi
.PCRSECT Identification of Person Reporting Problem
.nf
Name: Richard Conn
Address:
N/A
Electronic Mail: RCONN_@WSMR-SIMTEL20.ARMY.MIL
Phone: N/A
.fi
.PCRSECT Problem Classification and Description
.nf
Classification of Problem by Category
(Check all that apply):
Software Problem
X Documentation Problem
Design Problem
Classification of Problem by Priority
(Check all that apply, see the 2167A documentation for descriptions):
Priority 1
Priority 2
Priority 3
X Priority 4
Priority 5
.fi
.sp 2
.tp 10
.ul
Description of Problem
.PP
The DID Templates did not provide support for Problem/Change Reports.
In particular, it would be useful to be able to create standalone
Problem/Change Reports and also reuse the same report bodies in the
Version Description Document.
.PCRSECT Corrective Action
.sp
.ul
Person to whom Corrective Action is assigned
.sp
.nf
Richard Conn
.fi
.sp
.ul
Recommended Corrective Action Needed to Resolve Problem
.sp
.PP
Add the files PCR.PTF, PCRBODY.PTF, and PCRDESC.PTF to the distribution.
Modify the file VDD.PTF to incorporate PCRBODY.PTF and PCRDESC.PTF.
PCRBODY.PTF is a template for a reusable PCR which can be used to
create a standalone PCR by formatting PCR.PTF or to incorporate a PCR
into a VDD by formatting VDD.PTF. PCRDESC.PTF is a description of
the priority classifications used in the PCRBODY.PTF file.
.sp 2
.ul
Actions Actually Taken to Resolve Problem
.PP
Corrective action was followed. PCR.PTF, PCRBODY.PTF, and PCRDESC.PTF
are now part of the distribution, and VDD.PTF has been modified.
--::::::::::
--pcrdesc.ptf
--::::::::::
1: A software problem that does one of the following:
.br
.li +5
.ri +5
.sp
Prevents the accomplishment of an operational
or mission essential capability specified by
baselined requirements,
.sp
Prevents the operator's
accomplishment of an operational or mission
essential capability, or
.sp
Jeoparidzes personnel
safety.
.li -5
.ri -5
.sp
2: A software problem that does one of the following:
.br
.li +5
.ri +5
.sp
Adversely affects the operator's accomplishment
of an operational or mission essential
capability specified by baselined requirements
so as to degrade performance and for which no
alternative work-around solution is known or
.sp
Adversely affects the operator's accomplishment
of an operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which no alternative
work-around solution is known.
.li -5
.ri -5
.sp
3: A software problem that does one of the following:
.br
.li +5
.ri +5
.sp
Adversely affects the accomplishment of an
operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which an alternative
work-around solution is known or
.sp
Adversely
affects the operator's accomplishment of an
operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which an alternative
work-around solution is known.
.li -5
.ri -5
.sp
4: A software problem that is an operator inconvenience
or annoyance and which does not affect a required
operational or mission essential capability
.sp
5: All other errors
.br
--::::::::::
--didsum.doc
--::::::::::

Collection of DoD-STD-2167A DID Templates -- User's Manual

Version 2: 15 May 1990

SOFTWARE USER'S MANUAL

FOR THE

COLLECTION of DoD-STD-2167A DID TEMPLATES for PTF

CONTRACT NO. None

CDRL SEQUENCE NO. None

Prepared for:

Users of the Ada Software Repository
SIMTEL20 Host Computer
White Sands Missile Range, New Mexico 88002

Prepared by:

Richard Conn
Manager, Ada Software Repository

Collection of DoD-STD-2167A DID Templates -- User's Manual

1. Scope_____

1.1. Identification______________

This Software________ User's______ Manual______ (SUM) applies to Version 2
of the collection of DoD-STD-2167A DID template files for
processing by the Portable Text Formatter (PTF).

1.2. System______ overview________

This system is a collection of templates for all the
Data Item Descriptors (DIDs) documented in DoD-STD-2167A.
These templates are to be edited and tailored by the user
for his specific project. They contain instructions to the
user, telling him what items of information to insert at
various points in the template. The user replaces these
instructions with the information itself, transforming the
template into the document. Once the tailoring is complete
and all items required by the DID are filled in by the user,
the user may then execute the Portable Text Formatter (PTF)
to process the edited template into the formatted
deliverable document. The required section numbering, page
numbering, headers, table of contents, list of figures, list
of tables, and index will be generated automatically by PTF
in the format required by the DID.

This system consists of two sets of files: (1) the
common files, which are filled in once by the user and are
then read by the templates during their processing by PTF,
and (2) the DID templates themselves, where each
DoD-STD-2167A DID maps to one of the DID templates. The
common files provide information, such as the name of the
system, an overview of the system, and a list of acronyms,
which are needed by all or most of the DID templates. The
common files eliminate duplication of effort on the part of
the user by putting information needed by one or more DID in
a common location that can be read by the template. The DID
templates contain all the PTF commands and instructions to
the user for their use. The user instructions are always
enclosed in square brackets ([]), and, as the user works
with a template, he can read the instructions, input the
required information, and then delete everything within the
square brackets as he goes. The instructions in the square
brackets are, in effect, replaced by the information of the
DID itself. In some cases, the DID templates are
stand-alone; the user does not need to refer to the
DoD-STD-2167A DID to fill out the template. In other cases,
the DID template refers to the DoD-STD-2167A DID for more
information.

Collection of DoD-STD-2167A DID Templates -- User's Manual

The documentation provided with this system is a
Software________ User's______ Manual______ (DID DI-MCCR-80019A) and a Version_______
Description___________ Document________ (DID DI-MCCR-80013A). This
documentation was prepared as outlined above from the
respective DID templates and provides a living example of
this system in action. Other examples of this system in
action can be found in the Ada Software Repository (ASR) in
the Proposed MIL-HDBK-1804 documents and in the
documentation for the Portable Text Formatter (PTF).

This system represents an interpretation of the
DoD-STD-2167A document and its DIDs, and, while great care
was taken to be correct, errors may have been introduced.
Please report any such errors to the Manager, Ada Software
Repository. This system is a project of the Ada Software
Repository activity at White Sands and is not necessarily
endorsed by the United States Department of Defense as an
official representation of DoD-STD-2167A.

1.3. Document________ overview________

This SUM contains instructions on tailoring and editing
the DID template files and instructions on running PTF to
process the edited DID template files.

Collection of DoD-STD-2167A DID Templates -- User's Manual

2. Referenced__________ documents_________

Ada Software Repository, Portable________ Text____ Formatter_________ (PTF)
documentation set, PD2:<ADA.WORD_PROCESSORS> subdirectory
(at the time of this writing - subject to change)

Ada Software Repository, Proposed________ MIL-HDBK-1804_____________ (Ada____
Style_____ Guide),______, PD2:<ADA.DOCUMENTS> subdirectory (at the time
of this writing - subject to change)

Ada Software Repository, Software________ User's______ Manual______ for___ the___
Portable________ Text____ Formatter_________ (part of the PTF documentation set)

United States Department of Defense, Military________ Standard________
Defense_______ System______ Software________ Development,___________, DOD-STD-2167A, 29
February 1988

Collection of DoD-STD-2167A DID Templates -- User's Manual

3. Execution_________ procedures__________

This section presents a method for using this system of
DoD-STD-2167A DID templates for the preparation of the
deliverable documents. An understanding of the Portable
Text Formatter (PTF) and its use is assumed.

The following steps are recommended by this method for
DoD-STD-2167A documentation generation:

1. Create an empty working directory

2. Copy all the DID template files into it

This system should be copied into the working
directory in its entirety. The common files and
the DID template files will all be available to
the user.

3. Delete all unneeded DID template files

This step removes the DID template files for
the documents which are not to be produced.
Clutter in the working directory is reduced.

4. Edit the common template files

The common template files set the name of the
system (through the SYSNAME variable), the length
of the lines (through global left and right margin
setting commands), and the text of the overview of
the system which will be incorporated into many of
the deliverable documents. They are listed in
Appendix A.

5. Tailor the DID template files

Some sections or paragraphs may be omitted or
unneeded, some multiple-paragraph groups may have
to be planned (such as the group of paragraphs
describing each CSC, for example), and some
customer directive may specify certain ways to
tailor the DIDs.

6. Edit the DID template files

Fill in the required information.

7. Format the DID template files using PTF

8. Print and review the deliverable documents

Collection of DoD-STD-2167A DID Templates -- User's Manual

An iteration of the last few steps may be
necessary before the deliverable documents have
the desired appearance.

3.1. Editing_______ the___ Common______ Template________ Files_____

The first major action on the distribution files of
COLLECTION__________ of__ DoD-STD-2167A_____________ DID___ TEMPLATES_________ for___ PTF___ is to edit
the common template files. There are three common template
files (header.ptf, overview.ptf, and acronyms.ptf), and they
are listed in Appendix A. The reader may wish to refer to
them while reading this section.

The file header.ptf______.___ defines three sets of information:
(1) the name of the system, which is stored in the variable
SYSNAME, (2) the left and right margins of the document, and
(3) a set of useful macros. The variable SYSNAME is used
extensively throughout the DoD-STD-2167A DID templates, and
it contains the name of the system referenced by the DIDs.
The left and right margins should be set for the desired
margins and line length; the distribution sets these at 11
and 70, which gives a 60-character line length for PICA
type. The setting for ELITE type is 13 and 90, giving a
78-character line length. The macros are discussed in the
next section (Section 3.2).

The file acronyms.ptf________.___ defines commonly-used acronyms in
the documents. Note that the acronym listing in this file
is broken into groups so that any particular group will
appear with its header intact on a page. The user may or
may not choose to follow this convention. Also, it is
intended that this file contain all acronyms used in every
deliverable document so that it can be reused without the
user having to worry about not covering any particular
acronym.

The file overview.ptf________.___ is a concise description of the
system to which the DIDs apply. It is inserted into
virtually every deliverable document, and placing this
description into a separate file eliminates a lot of
duplication and provides a common point for modification.

Collection of DoD-STD-2167A DID Templates -- User's Manual

3.2. Using_____ the___ Macros______ in__ the___ File____ header.ptf______.___

The following groups of macros are defined in the
header.ptf______.___ file:

Group Macro Name Comment_____ _____ ____ _______

1 SECT Define a new section

2 LIST Start a list of items
LE Define a list item
ELIST End a list of items

3 SLIST Start a sublist of items
SLE Define a sublist item
ESLIST End a sublist of items

4 PP Start a new paragraph

5 FIG Define a figure
PRFIG Print the list of figures

6 TAB Define a table
PRTAB Print the list of tables

7 PCRSTART Start a new PCR
PCRSECT Start a new section of a PCR

Each macro is described below.

3.2.1. SECT____ Macro_____

The general format of the SECT macro is:

SECT <identation level> <number> <text>

SECT is used to define a new section of the document.
SECT places an entry into the table of contents and places a
left-justified underlined title on the current page. Two
blank lines are placed before the section title in the
document, and a test is performed (with a page eject if the
test fails) to see if 10 lines remain on the page. The SECT
macro requires three parameters:

1. <indentation level>

This is a number from 0 on up which
indicates the number of three-space groups to
place before the entry in the table of
contents. For instance, an <indentation level>
of 0 places no spaces before the entry, 1
places three spaces, 2 places six spaces, etc.

Collection of DoD-STD-2167A DID Templates -- User's Manual

2. <number>

This is the number of the section. It
must not contain any spaces. This number will
appear in both the table of contents and the
body of the document, but, unlike the <text> of
the section, it will not be underlined in the
body.

3. <text>

This is the text to appear as the title of
the section. It will appear in both the table
of contents and the body of the document, and
it will be underlined in the body of the
document.

The following are examples of the use of the SECT
macro:

1. Example 1 (.SECT 1 2.2. Examples of SECT)

This example places the following text
(between the quotes) into the table of contents
(# is the page number, and there may be more or
less dots, depending on the line length). Note
the three leading spaces:

" 2.2. Examples of SECT . . . . . #"

This example also places the following
text (between the quotes) into the document,
left-justified against the left margin:

"2.2. Examples________ of__ SECT____ "

2. Example 2 (.SECT 0 1. Introduction)

"1. Introduction . . . . . . . . . . . #"

This example also places the following
text (between the quotes) into the document,
left-justified against the left margin:

"1. Introduction____________ "

Collection of DoD-STD-2167A DID Templates -- User's Manual

3.2.2. LIST____ Macro_____

The LIST macro defines the start of a new list of
items. Its one argument is the number of spaces (both left
and right) to indent the list. This macro sets the
indentation (left and right) and zeroes the number register
used to number the list items.

The following text fragment shows the use of the three
macros (LIST, LE, and ELIST) to create a list of items:

.LIST 4
.LE This is the first item.
These lines supplement the description of the first item.
.LE This is the second item.
These lines supplement the description of the second item.
.ELIST

The above list appears as follows:

1. This is the first item.
These lines supplement the description of the first
item.

2. This is the second item.
These lines supplement the description of the second
item.

3.2.3. LE__ Macro_____

The LE macro defines an item in a list. Each list item
is preceeded by a blank line, a list element number, a
period, and the text part of the ".LE <text>" macro call.
The line generated by the LE macro is indented to the left
by the number of spaces given in the LIST macro; all other
lines following the LE macro are right and left justified
within the bounds set by the LIST macro. See Section 3.2.2
for an example of the use of the LE macro.

3.2.4. ELIST_____ Macro_____

The ELIST macro ends a list of items. The indentation
set by the LIST macro is cleared, and a break is issued.
See Section 3.2.2 for an example of the use of the ELIST
macro.

Collection of DoD-STD-2167A DID Templates -- User's Manual

3.2.5. SLIST_____ Macro_____

The SLIST macro and its associated macros (SLE and
ESLIST) allow the user to place a sublist within a list.
Like the LIST macro, the SLIST macro requires one argument
which specifies the number of spaces to indent on both the
right and the left sides. This is in addition to the
indentation already being performed as a result of the outer
LIST macro. The SLIST macro also zeroes a second number
register which is used to number the sublist elements.

The following text fragment shows the use of the three
macros (SLIST, SLE, and ESLIST) to create a sublist of items
within a list:

.LIST 4
.LE This is the first item.
These lines supplement the description of the first item.
.SLIST 4
.SLE This is the first sublist's first item.
.SLE This is the first sublists's second item.
.ESLIST
.LE This is the second item.
.SLIST 4
.SLE This is the second sublist's first item.
.SLE This is the second sublist's second item.
.ESLIST
These lines supplement the description of the second item.
.ELIST

The following text fragment shows the use of these six
macros (LIST, LE, ELIST, SLIST, SLE, and ESLIST) to create a
list of items:

1. This is the first item.
These lines supplement the description of the first
item.

1.1. This is the first sublist's first item.

1.2. This is the first sublists's second item.

2. This is the second item.

2.1. This is the second sublist's first item.

2.2. This is the second sublist's second item.
These lines supplement the description of the second
item.

Collection of DoD-STD-2167A DID Templates -- User's Manual

3.2.6. SLE___ Macro_____

The SLE macro defines an item in a sublist. Each
sublist item is preceeded by a blank line, a list element
number, a period, a sublist element number, a period, and
the text part of the ".SLE <text>" macro call. The line
generated by the SLE macro is indented to the left by the
number of spaces given in the SLIST macro; all other lines
following the SLE macro are right and left justified within
the bounds set by the SLIST macro. See Section 3.2.5 for an
example of the use of the SLE macro.

3.2.7. ESLIST______ Macro_____

The ESLIST macro ends a sublist of items. The
indentation set by the SLIST macro is cleared, and a break
is issued. See Section 3.2.5 for an example of the use of
the ESLIST macro.

3.2.8. PP__ Macro_____

The PP macro starts a new paragraph. A blank line is
generated, and the text which starts on the line following
the ".PP" macro call is indented by five spaces.

3.2.9. FIG___ Macro_____

The FIG macro is used to place the heading for a figure
on the page and make an entry into the list of figures. The
FIG macro call is of the form:

.FIG <indentation level> <text>

The <indentation level> parameter indicates the number
of groups of three spaces to indent the entry in the list of
figures. The <text> contains the title of the figure. No
numbering is assumed, so if a list of numbered figures is
desired, the number must be placed into the FIG macro call
explicitly (e.g., 1) or implicitly (e.g., by using number
registers, like @nf). The phrase

Figure <text>

will appear centered and underlined in the document at the
point of the FIG macro call.

Collection of DoD-STD-2167A DID Templates -- User's Manual

3.2.10. PRFIG_____ Macro_____

The PRFIG macro is used to print the list of figures.
PRFIG will cause a page break, the title "List of Figures"
to be centered and underlined, two blank lines, and the list
of all figures defined so far. The list of figures
accumulated to date will be cleared after the PRFIG macro
completes its function, so PRFIG may be used only once.

3.2.11. TAB___ Macro_____

The TAB macro is used to place the heading for a table
on the page and make an entry into the list of tables. Like
the FIG macro call, the TAB macro call is of the form:

.TAB <indentation level> <text>

The <indentation level> parameter indicates the number
of groups of three spaces to indent the entry in the list of
tables. The <text> contains the title of the table. No
numbering is assumed, so if a list of numbered tables is
desired, the number must be placed into the TAB macro call
explicitly (e.g., 1) or implicitly (e.g., by using number
registers, like @nf). The phrase

Table <text>

will appear centered and underlined in the document at the
point of the TAB macro call.

3.2.12. PRTAB_____ Macro_____

The PRTAB macro is used to print the list of tables.
PRTAB will cause a page break, the title "List of Tables" to
be centered and underlined, two blank lines, and the list of
all tables defined so far. The list of tables accumulated
to date will be cleared after the PRTAB macro completes its
function, so PRTAB may be used only once.

3.2.13. PCRSTART________ Macro_____

The PCRSTART macro is used to start a new
Problem/Change Report (PCR). PCRSTART will cause the number
register p to be set to zero, a contents line, at
indentation level 2, to be placed into the table of
contents, and a title line to be placed into the PCR. No
blank lines are added, so the user may wish to follow a
PCRSTART macro with an .sp 2 command or the like.

The syntax of the PCRSTART macro is:

Collection of DoD-STD-2167A DID Templates -- User's Manual

.PCRSTART <title of PCR>

See the Section 3.3 for more discussion of PCRs.

3.2.14. PCRSECT_______ Macro_____

The PCRSECT macro is used to start a new section in a
Problem/Change Report (PCR). The number register p is
incremented and used as the section number.

The syntax of the PCRSECT macro is:

.PCRSECT <title of PCR section>

See the Section 3.3 for more discussion of PCRs.

3.3. Editing_______ the___ DID___ Template________ Files_____

Each DID template file is ready for processing by PTF
as distributed. If the user makes no modifications to the
template at all, PTF will produce a deliverable document
that shows the structure of the DID as a whole and contains
explanatory comments enclosed in square brackets. The first
time that COLLECTION__________ of__ DoD-STD-2167A_____________ DID___ TEMPLATES_________ for___ PTF___
is used, the user may wish to run PTF on some raw DID
template files to get a feeling of what the resulting
deliverable documents will look like.

Once the common template files documented in Section
3.2 are prepared, the groundwork is laid for preparing the
17 DID templates files. Each DID template file reads in the
common template files at the appropriate point in the DID
template and provides the facilities of the common template
file (in the case of the header.ptf file) or the text of the
common template file (in the case of the acronyms.ptf and
overview.ptf files). Filling in the rest of the DID
template file is a matter of reading the DID template and
replacing all areas of the template which are surrounded by
square brackets ([]) with the text. The areas surrounded by
the square brackets contain instructions which explain the
information to enter in their place. The user may have to
refer to the actual DoD-STD-2167A DID for further
elaboration.

The files PCRBODY.PTF and PCRDESC.PTF are used as
templates for creating a number of Problem/Change Reports
(PCRs). At the user's discretion, PCRs may be generated
standalone using the PCR.PTF file or may be incorporated
into a Version Description Document's appendix via the file
VDD.PTF. The idea is to create a new version of PCRBODY.PTF
for each PCR, each version of PCRBODY.PTF having a different
name (e.g., PCR001.PTF).

Collection of DoD-STD-2167A DID Templates -- User's Manual

For example, the following shows sections 3.5 to 3.7 of
the Version_______ Description___________ Document________ DID. Note the explanatory
comments enclosed in the square brackets.

.SECT 1 3.5. Adaptation data
.PP
[For the initial release of a CSCI, this paragraph shall identify
or reference all unique-to-site data contained in the items being
delivered. For subsequent CSCI versions, this paragraph shall contain
the information necessary to identify changes made to the
adaptation data.]
.SECT 1 3.6. Interface compatibility
.PP
[This paragraph shall indicate other systems and configuration items
affected by the changes incorporated in this version. Note: This
paragraph does not apply to the initial version of a CSCI.]
.SECT 1 3.7. Bibliography of reference documents
.PP
[For the initial version of a CSCI, this paragraph shall list
all documents pertinent to the CSCI. For subsequent CSCI versions,
this paragraph shall identify changes to the listed documents.]

In processing these sections of the DID template file,
the user would read the comments in the square brackets,
enter the text as required, and then delete the comments in
the square brackets.

3.4. Running_______ PTF___ to__ Produce_______ the___ Deliverable___________ Documents_________

PTF is run on the DID template files to produce the
deliverable documents. See the Software________ User's______ Manual______ for___
the___ Portable________ Text____ Formatter_________ for complete details on its use.
Simply put, the DID template files are processed by PTF
command lines of the following format:

PTF <DID template file name> <output file name>

For example,

ptf vdd.ptf vdd.doc
ptf sum.ptf sum.doc

Collection of DoD-STD-2167A DID Templates -- User's Manual

4. Error_____ messages________

Not applicable for this system. See the Software________
User's______ Manual______ for___ the___ Portable________ Text____ Formatter_________ for error
messages generated by the Portable Text Formatter.

Collection of DoD-STD-2167A DID Templates -- User's Manual

5. Notes_____

5.1. Acronyms________

Acronyms________

Acronym Meaning_______ _______
ASR Ada Software Repository
CDR Criticial Design Review
CDRL Contract Data Requirements List
CIDS Critical Item Development Specification
CRISD Computer Resources Integrated Support Document
CSC Computer Software Component
CSCI Computer Software Configuration Item
CSOM Computer System Operator's Manual
CSU Computer Software Unit
DID Data Item Description
DOD Department of Defense
DODISS Department of Defense Index of Specifications
and Standards
ECP Engineering Change Proposal
FAR Gederal Acquisition Regulation
FCA Functional Configuration Audit
FSM Firmware Support Manual
FQT Formal Qualification Testing
GFE Government Furnished Equipment
GFI Government Furnished Information
GFS Government Furnished Software

Acronym Meaning_______ _______
HOL High Order Language
HWCI Hardware Configuration Item
ICD Interface Control Document
IDD Interface Design Document
I/O Input/Output
IRS Interface Requirements Specification
IV&V Independent Verification and Validation
NDS Non-development Software
PCA Physical Configuration Audit
PCR Problem/Change Report
PDR Preliminary Design Review
PIDS Prime Item Development Specification
PTF Portable Text Formatter

Collection of DoD-STD-2167A DID Templates -- User's Manual

Acronym Meaning_______ _______
SCN Specification Change Notice
SDD Software Design Document
SDF Software Development File
SDL Software Development Library
SDP Software Development Plan
SDR Software Design Review
SOW Statement of Work
SPM Software Programmer's Manual
SPS Software Product Specification
SRR Software Requirements Review
SRS Software Requirements Specification
SSDD System/Segment Design Document
SSR Software Specification Review
SSS System/Segment Specification
STD Software Test Description
STP Software Test Plan
STR Software Test Report
SUM Software User's Manual

Acronym Meaning_______ _______
TRR Test Readiness Review
VDD Version Description Document
WBS Work Breakdown Structure

5.2. Definitions___________ of__ Terms_____ Used____ in__ this____ Document________

common______ files_____ or common______ template________ files_____ - files read by
more than one of the DID___ template________ files_____ that provide text
that is repeated in the deliverable documents; the common______
template________ files_____ delivered with this version of COLLECTION__________ of__
DoD-STD-2167A_____________ DID___ TEMPLATES_________ for___ PTF___ are listed in Appendix A

deliverable___________ documents_________ - documents which are described
by the DoD-STD-2167A DIDs and are to be delivered to the
customer; the DIDs for these documents are called out on the
CDRL

DID___ template________ files_____ - the files delivered with this
system which, when processed by PTF, create the deliverable
documents

Collection of DoD-STD-2167A DID Templates -- User's Manual

This page intentionally blank

Collection of DoD-STD-2167A DID Templates -- User's Manual

A. Listings________ of__ Common______ Files_____ Used____ by__ the___ DID___ Templates_________

This appendix contains listings of the common files
used by the DID templates. It may be convenient to refer to
these listings during the reading of this Software________ User's______
Manual.______.

A.1. Listing_______ of__ File____ header.ptf______.___

.comment
.! Enter the name of the system below
.comment
.vs SYSNAME [SYSTEM NAME]

A-1

Collection of DoD-STD-2167A DID Templates -- User's Manual

.! -- end a list of items; the indentation set by .LIST is
.! -- unset; a break is issued
.!
.! .SLIST <number of spaces to indent>
.! -- start a sublist of items while in a list; the sublist will
.! -- be further indented from the right and left by the
.! -- indicated number of spaces
.!
.! .SLE <text>
.! -- enter a new list item into the sublist; this may be
.! -- followed by more lines containing text associated
.! -- with the sublist entry; a blank line is generated
.! -- followed by N.M (N=list element number, M=sublist number),
.! -- a period, and <text> extended to the left by the
.! -- <number of spaces to indent> set by the .SLIST macro
.!
.! .ESLIST
.! -- end a sublist of items and continue with the list
.!
.! .PP
.! -- skip a line and start a new paragraph, indented by 5
.! -- spaces
.!
.! .FIG <indentation level> <text>
.! -- enter a figure into the "List of Figures"
.!
.! .PRFIG
.! -- print the "List of Figures"
.!
.! .TAB <indentation level> <text>
.! -- enter a table into the "List of Tables"
.!
.! .PRTAB
.! -- print the "List of Tables"
.!
.! .PCRSTART <title text>
.! -- start a new Problem/Change Report
.!
.! .PCRSECT <section title text>
.! -- start a new section in a Problem/Change Report
.!
.comment

A-2

Collection of DoD-STD-2167A DID Templates -- User's Manual

.define LIST
.vs LISTINDENT @1
.li +@LISTINDENT
.ri +@LISTINDENT
.nr a 0
.en
.! ------------------------------------------------
.define LE
.sp
.ti -@LISTINDENT
.nr a +1
@na.
@1 @2 @3 @4 @5 @6 @7 @8 @9
.br
.en
.! ------------------------------------------------
.define ELIST
.br
.li -@LISTINDENT
.ri -@LISTINDENT
.en
.! ------------------------------------------------
.define SLIST
.vs SLISTINDENT @1
.li +@SLISTINDENT
.ri +@SLISTINDENT
.nr b 0
.en
.! ------------------------------------------------
.define SLE
.sp
.ti -@SLISTINDENT
.nr b +1
@na.@nb.
@1 @2 @3 @4 @5 @6 @7 @8 @9
.br
.en
.! ------------------------------------------------
.define ESLIST
.br
.li -@SLISTINDENT
.ri -@SLISTINDENT
.en
.! ------------------------------------------------
.define PP
.sp
.ti +5
.en
.! ------------------------------------------------
.define FIG
.contsel 1
.cl @1 @2 @3 @4 @5 @6 @7 @8 @9
.ul
.ce

A-3

Collection of DoD-STD-2167A DID Templates -- User's Manual

Figure @2 @3 @4 @5 @6 @7 @8 @9
.contsel
.en
.! ------------------------------------------------
.define PRFIG
.contsel 1
.bp
.ce
.ul
List of Figures
.sp 2
.pc
.contsel
.en
.! ------------------------------------------------
.define TAB
.contsel 2
.cl @1 @2 @3 @4 @5 @6 @7 @8 @9
.ul
.ce
Table @2 @3 @4 @5 @6 @7 @8 @9
.contsel
.en
.! ------------------------------------------------
.define PRTAB
.contsel 2
.bp
.ce
.ul
List of Tables
.sp 2
.pc
.contsel
.en
.! ------------------------------------------------
.define PCRSTART
.tp 10
.contline 2 @1 @2 @3 @4 @5 @6 @7 @8 @9
PCR:
.ul
@1 @2 @3 @4 @5 @6 @7 @8 @9
.br
.nr p 0
.en
.! ------------------------------------------------
.define PCRSECT
.sp 2
.tp 10
------------------------------------------------------------
.nr p +1
Section @np --
.ul
@1 @2 @3 @4 @5 @6 @7 @8 @9
.sp

A-4

Collection of DoD-STD-2167A DID Templates -- User's Manual

.en

A.2. Listing_______ of__ File____ overview.ptf________.___

.comment
.! This is a system overview, which is common to many
.! of the DoD-STD-2167A DIDs.
.comment
.PP
[This paragraph shall briefly state the purpose of the system and the
CSCI(s) to which this DID deliverable applies.]

A.3. Listing_______ of__ File____ acronyms.ptf________.___

.comment
.! This include file contains a table of acronyms which is used
.! in many of the DoD-STD-2167A documents.
.comment
.sp 2
.ce
.ul
Acronyms
.sp 1
.nf
.na
.need 22
.ul
Acronym Meaning
CDR Criticial Design Review
CDRL Contract Data Requirements List
CIDS Critical Item Development Specification
CRISD Computer Resources Integrated Support Document
CSC Computer Software Component
CSCI Computer Software Configuration Item
CSOM Computer System Operator's Manual
CSU Computer Software Unit
DID Data Item Description
DOD Department of Defense
DODISS Department of Defense Index of Specifications and Standards
ECP Engineering Change Proposal
FAR Gederal Acquisition Regulation
FCA Functional Configuration Audit
FSM Firmware Support Manual
FQT Formal Qualification Testing
GFE Government Furnished Equipment
GFI Government Furnished Information

A-5

Collection of DoD-STD-2167A DID Templates -- User's Manual

GFS Government Furnished Software

A-6

Collection of DoD-STD-2167A DID Templates -- User's Manual

This page intentionally blank

A-7

Collection of DoD-STD-2167A DID Templates -- User's Manual

Table of Contents_____ __ ________

1. Scope ................................................ 1
1.1. Identification .................................. 1
1.2. System overview .................................. 1
1.3. Document overview ................................ 2

2. Referenced documents .................................. 3

3. Execution procedures .................................. 4
3.1. Editing the Common Template Files ................ 5
3.2. Using the Macros in the File header.ptf .......... 5
3.2.1. SECT Macro .................................. 6
3.2.2. LIST Macro .................................. 7
3.2.3. LE Macro .................................... 8
3.2.4. ELIST Macro ................................ 8
3.2.5. SLIST Macro ................................ 8
3.2.6. SLE Macro .................................. 9
3.2.7. ESLIST Macro ............................... 10
3.2.8. PP Macro ................................... 10
3.2.9. FIG Macro ................................. 10
3.2.10. PRFIG Macro ............................... 10
3.2.11. TAB Macro ................................. 11
3.2.12. PRTAB Macro ............................... 11
3.2.13. PCRSTART Macro ........................... 11
3.2.14. PCRSECT Macro ............................. 12
3.3. Editing the DID Template Files ................. 12
3.4. Running PTF to Produce the Deliverable Documents 13

4. Error messages ....................................... 14

5. Notes ............................................... 15
5.1. Acronyms ....................................... 15
5.2. Definitions of Terms Used in this Document ..... 16

A. Listings of Common Files Used by the DID Templates .. A-1
A.1. Listing of File header.ptf .................... A-1
A.2. Listing of File overview.ptf .................. A-5
A.3. Listing of File acronyms.ptf .................. A-5

Collection of DoD-STD-2167A DID Templates -- User's Manual

This page intentionally blank

iii
--::::::::::
--didvdd.doc
--::::::::::

Collection of DoD-STD-2167A DID Templates for PTF - VDD

Version 2: 15 May 1990

VERSION DESCRIPTION DOCUMENT

FOR THE

COLLECTION of DoD-STD-2167A DID TEMPLATES for PTF

CONTRACT NO. None

CDRL SEQUENCE NO. None

Prepared for:

Users of the Ada Software Repository
SIMTEL20 Host Computer
White Sands Missile Range, New Mexico

Prepared by:

Richard Conn
Manager, Ada Software Repository

Collection of DoD-STD-2167A DID Templates for PTF - VDD

1. Scope_____

1.1. Identification______________

This Version_______ Description___________ Document________ (VDD) applies to
Version 2 of the collection of DoD-STD-2167A DID template
files for processing by the Portable Text Formatter (PTF).

1.2. System______ overview________

Collection of DoD-STD-2167A DID Templates for PTF - VDD

1.3. Documentation_____________ overview________

This VDD contains documentation on the files associated
with this release, and, when a released file is composed of
several component files, this VDD identifies and describes
these component files as well.

Collection of DoD-STD-2167A DID Templates for PTF - VDD

2. Referenced__________ documents_________

Ada Software Repository, PAGER2______ tool and documentation
set, PD2:<ADA.PAGER> subdirectory (at the time of this
writing - subject to change)

Ada Software Repository, Portable________ Text____ Formatter_________ (PTF)
documentation set, PD2:<ADA.WORD_PROCESSORS> subdirectory
(at the time of this writing - subject to change)

Ada Software Repository, Software________ User's______ Manual______ for___ the___
COLLECTION__________ of__ DoD-STD-2167A_____________ DID___ TEMPLATES_________ for___ PTF,___,
PD2:<ADA.DOD-STD-2167A> subdirectory (at the time of this
writing - subject to change)

United States Department of Defense, Military________ Standard________
Defense_______ System______ Software________ Development,___________, DOD-STD-2167A, 29
February 1988

Collection of DoD-STD-2167A DID Templates for PTF - VDD

3. Version_______ description___________

3.1. Inventory_________ of__ materials_________ released________

Six files comprise this distribution:

File Name Description ____ ____ ___________
did2167a.src Collection of template files
did2167a.inc Listing of files in did2167a.src
did2167a.pro Ada Software Repository Prologue
didsum.doc Formatted Software User's Manual
for this system
didvdd.doc Formatted Version Description Document
for this system
diddoc.src PTF sources for the Software User's
Manual and the Version Description
Document

The files DIDVDD.DOC and DIDSUM.DOC are formatted
documents which describe this distribution and how to use
this system.

3.2. Inventory_________ of__ CSCI____ contents________

The file DID2167A.SRC contains:

Common Template Files______ ________ _____

File Name Description ____ ____ ___________
acronyms.ptf List of acronyms
header.ptf Header (with layout and SYSNAME info)
overview.ptf Overview of system

Collection of DoD-STD-2167A DID Templates for PTF - VDD

Template Files of Deliverable Documents________ _____ __ ___________ _________

File Name Description ____ ____ ___________
sss.ptf System/Segment Specification
DI-CMAN-80008A
ssdd.ptf System/Segment Design Document
DI-CMAN-80534
sdd.ptf Software Design Document
DI-MCCR-80012A
vdd.ptf Version Description Document
DI-MCCR-80013A
stp.ptf Software Test Plan
DI-MCCR-80014A
std.ptf Software Test Description
DI-MCCR-80015A
str.ptf Software Test Report
DI-MCCR-80017A
csom.ptf Computer System Operator's Manual
DI-MCCR-80018A
sum.ptf Software User's Manual
DI-MCCR-80019A
spm.ptf Software Programmer's Manual
DI-MCCR-80021A
fsm.ptf Firmware Support Manual
DI-MCCR-80022A
crisd.ptf Computer Resources Integrated Support
Document
DI-MCCR-80024A
srs.ptf Software Requirements Specification
DI-MCCR-80025A
irs.ptf Interface Requirements Specification
DI-MCCR-80026A
idd.ptf Interface Design Document
DI-MCCR-80027A
sps.ptf Software Product Specification
DI-MCCR-80029A
sdp.ptf Software Development Plan
DI-MCCR-80030A
pcr.ptf Standalone Problem/Change Report
pcrbody.ptf Reusable Problem/Change Report Template
pcrdesc.ptf PCR Priority Classifications

3.3. Class_____ I_ changes_______ installed_________

None.

Collection of DoD-STD-2167A DID Templates for PTF - VDD

3.4. Class_____ II__ changes_______ installed_________

None. However, one Priority 4 change has been
installed. See Appendix A for a description of it.

3.5. Adaptation__________ data____

No adaptation is required as the computing environment
changes. This system depends upon the proper installation
of the PTF program. See Section 3.5 of the Version_______
Description___________ Document________ for___ the___ Portable________ Text____ Formatter_________ for
details on the adaptation of PTF.

3.6. Interface_________ compatibility_____________

Not applicable.

3.7. Bibliography____________ of__ reference_________ documents_________

Ada Software Repository, PAGER2______ tool and documentation
set, PD2:<ADA.PAGER> subdirectory (at the time of this
writing - subject to change)

Ada Software Repository, Portable________ Text____ Formatter_________ (PTF)
documentation set, PD2:<ADA.WORD_PROCESSORS> subdirectory
(at the time of this writing - subject to change)

3.8. Summary_______ of__ change______

See Appendix A for details.

3.9. Installation____________ instructions____________

1. Copy the file DID2167A.SRC into an empty working
directory.

2. Break down this file into each of its component
files (listed in Section 3.2 above). The PAGER2 tool from
the Ada Software Repository may be used to do this by
issuing the following command:

pager2 u did2167a.src

If PAGER2 is not available or has not been installed on your

Collection of DoD-STD-2167A DID Templates for PTF - VDD

system, a conventional text editor (which can handle large
ASCII files) can be used to edit DID2167A.SRC and extract
each of the component files manually. Each component file
is prefixed by a PAGER2 banner of the form:

--::::::::::
--filename
--::::::::::

3.10. Possible________ problems________ and___ known_____ errors______

There are no known errors with this system. Problems
encountered are usually due to problems in using the PTF
program, and this information is detailed in the PTF
documentation set.

Collection of DoD-STD-2167A DID Templates for PTF - VDD

4. Notes_____

Acronyms________

Collection of DoD-STD-2167A DID Templates for PTF - VDD

Acronym Meaning_______ _______
TRR Test Readiness Review
VDD Version Description Document
WBS Work Breakdown Structure

Collection of DoD-STD-2167A DID Templates for PTF - VDD

This page intentionally blank

Collection of DoD-STD-2167A DID Templates for PTF - VDD

A. Problem/Change______________ Reports_______

PCR: Add___ PCR___ Files_____

------------------------------------------------------------
Section 1 -- Software________ System______ Identification______________

System Name: COLLECTION of DoD-STD-2167A DID TEMPLATES for PTF
Version Number: 1
Version Date (if known): 21 September 1989

------------------------------------------------------------
Section 2 -- Identification______________ of__ Person______ Reporting_________ Problem_______

Name: Richard Conn
Address:
N/A
Electronic Mail: RCONN@WSMR-SIMTEL20.ARMY.MIL
Phone: N/A

------------------------------------------------------------
Section 3 -- Problem_______ Classification______________ and___ Description___________

Classification of Problem by Category
(Check all that apply):
Software Problem
X Documentation Problem
Design Problem
Classification of Problem by Priority
(Check all that apply, see the 2167A documentation for descriptions):
Priority 1
Priority 2
Priority 3
X Priority 4
Priority 5

A-1

Collection of DoD-STD-2167A DID Templates for PTF - VDD

Description___________ of__ Problem_______

The DID Templates did not provide support for
Problem/Change Reports. In particular, it would be useful
to be able to create standalone Problem/Change Reports and
also reuse the same report bodies in the Version Description
Document.

------------------------------------------------------------
Section 4 -- Corrective__________ Action______

Person______ to__ whom____ Corrective__________ Action______ is__ assigned________

Richard Conn

Recommended___________ Corrective__________ Action______ Needed______ to__ Resolve_______ Problem_______

Add the files PCR.PTF, PCRBODY.PTF, and PCRDESC.PTF to
the distribution. Modify the file VDD.PTF to incorporate
PCRBODY.PTF and PCRDESC.PTF. PCRBODY.PTF is a template for
a reusable PCR which can be used to create a standalone PCR
by formatting PCR.PTF or to incorporate a PCR into a VDD by
formatting VDD.PTF. PCRDESC.PTF is a description of the
priority classifications used in the PCRBODY.PTF file.

Actions_______ Actually________ Taken_____ to__ Resolve_______ Problem_______

Corrective action was followed. PCR.PTF, PCRBODY.PTF,
and PCRDESC.PTF are now part of the distribution, and
VDD.PTF has been modified.

A-2

Collection of DoD-STD-2167A DID Templates for PTF - VDD

This Page Intentionally Blank

A-3

Collection of DoD-STD-2167A DID Templates for PTF - VDD

B. Problem/Change______________ Report______ Priority________ Classification______________

1: A software problem that does one of the following:

Prevents the accomplishment of an operational or
mission essential capability specified by
baselined requirements,

Prevents the operator's accomplishment of an
operational or mission essential capability, or

Jeoparidzes personnel safety.

2: A software problem that does one of the following:

Adversely affects the operator's accomplishment of
an operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which no alternative
work-around solution is known or

3: A software problem that does one of the following:

Adversely affects the accomplishment of an
operational or mission essential capability
specified by baselined requirements so as to
degrade performance and for which an alternative
work-around solution is known or

4: A software problem that is an operator inconvenience or
annoyance and which does not affect a required operational
or mission essential capability

5: All other errors

B-1

Collection of DoD-STD-2167A DID Templates for PTF - VDD

This Page Intentionally Blank

B-2

Collection of DoD-STD-2167A DID Templates for PTF - VDD

Table of Contents_____ __ ________

2. Referenced documents .................................. 3

3. Version description .................................. 4
3.1. Inventory of materials released .................. 4
3.2. Inventory of CSCI contents ...................... 4
3.3. Class I changes installed ........................ 5
3.4. Class II changes installed ...................... 5
3.5. Adaptation data .................................. 6
3.6. Interface compatibility .......................... 6
3.7. Bibliography of reference documents .............. 6
3.8. Summary of change ................................ 6
3.9. Installation instructions ........................ 6
3.10. Possible problems and known errors .............. 7

4. Notes ................................................ 8

A. Problem/Change Reports .............................. A-1
Add PCR Files .................................... A-1

B. Problem/Change Report Priority Classification ...... B-1

Collection of DoD-STD-2167A DID Templates for PTF - VDD

This page intentionally blank

iii
</PRE>
</BODY>