top - download
⟦b94fe9414⟧ Wang Wps File
Length: 13671 (0x3567)
Types: Wang Wps File
Notes: Softw.Subs.Docum. Stand.
Names: »0266A «
Derivation
└─⟦e91c96c30⟧ Bits:30006069 8" Wang WCS floppy, CR 0025A
└─ ⟦this⟧ »0266A «
WangText
…02…SD/STD/013
…02…SVO/801020…02……02…#
SOFTWARE SUBSYSTEM DOCUMENTATION STANDARD
…02……02…GENERAL
T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲
1 SCOPE ........................................
3
2 PURPOSE ......................................
3
3 ORGANIZATION .................................
3
3.1 SYNOPSIS .................................
3
3.1.2 Tayloring of Synopsis ................
3
3.2 LAYOUT ...................................
4
3.3 CONTENT ..................................
4
3.3.1 Language Style .......................
4
4 DETAILED DESCRIPTION .........................
5
4.1 GENERAL ..................................
6
4.2 SUMMARY OF REQUIREMENTS ..................
7
4.3 ENVIRONMENT ..............................
8
4.4 DESIGN DETAILS ...........................
10
1̲ ̲ ̲S̲C̲O̲P̲E̲
This standard is a derivative of software standard
man- ual SD/STM/003 and has the same scope and applicability.
2̲ ̲ ̲P̲U̲R̲P̲O̲S̲E̲
This standard describes the organisation and layout
to be used for documents containing specification of
Software subsystems.
3̲ ̲ ̲O̲R̲G̲A̲N̲I̲Z̲A̲T̲I̲O̲N̲
3.1 S̲Y̲N̲O̲P̲S̲I̲S̲
The content of Software module specifications shall
be organized as described in NATO's ADP standard 007-3
annex C.
3.1.2 T̲a̲y̲l̲o̲r̲i̲n̲g̲ ̲o̲f̲ ̲S̲y̲n̲o̲p̲s̲i̲s̲
Software modules may vary considerably in size, complexity
and content, therefore, this synopsis may need some
tayloring to adapt it to the actual case.
Some of the paragraphs in the synopsis may be redundant
as no information exists which fits in them. They
shall be kept in the Table of Contents but marked "Not
Applicable".
Information may exist which does not fit directly into
any paragraph. In this case an interpretation of the
synopsis must be made to find the best fit. Invention
of new paragraphs or rearranging shall be avoided unless
absolutely necessary.
3.2 L̲A̲Y̲O̲U̲T̲
The editorial style of all documents shall be as described
in Document Layout Standard SD/STD/002.
3.3 C̲O̲N̲T̲E̲N̲T̲
The main content of all parts of the specification
shall be narrative descriptions written in plain English
language.
3.3.1 L̲a̲n̲g̲u̲a̲g̲e̲ ̲S̲t̲y̲l̲e̲
The paramount consideration in a specification is its
technical essence, and this should be presented in
a language free of vague and ambiguous terms and using
the simplest words and phrases which convey the intended
meaning. Inclusion of essential information shall
be complete, either by direct statements or by reference
to other documents. Consistency in terminology and
organization of material will contribute to the specification's
clarity and usefulness. Sentences shall be as short
and concise as possible. Punctuation should aid in
reading and prevent misreading. Well-planned word
order requires a minimum of punctuation. When extensive
punctuation is necessary for clarity, the sentence(s)
shall be rewritten. Sentences with compound clauses
shall be converted into short and concise separate
sentences.
4̲ ̲ ̲D̲E̲T̲A̲I̲L̲E̲D̲ ̲D̲E̲S̲C̲R̲I̲P̲T̲I̲O̲N̲
1. G̲E̲N̲E̲R̲A̲L̲
a. Purpose Statement
b. Project References
c. Terms and Abbreviations
2. S̲U̲M̲M̲A̲R̲Y̲ ̲O̲F̲ ̲R̲E̲Q̲U̲I̲R̲E̲M̲E̲N̲T̲S̲
a. System/Subsystem Description
b. System/Subsystem Functions
c. Accuracy and Validity
d. Timing e. Flexibility
3. E̲N̲V̲I̲R̲O̲N̲M̲E̲N̲T̲
a. Equipment Environment
b. Support Software Environment
c. Interfaces d. Security
e. Controls
4. D̲E̲S̲I̲G̲N̲ ̲D̲E̲T̲A̲I̲L̲S̲
a. General Operating Procedures
b. System Logical Flow c. System
Data d. Program
Description
T̲A̲B̲L̲E̲ ̲1̲
The above table lists all the sections into which the
content of a software subsystem specification shall
be organized.
The following contains a description of the content
of each section.
4.1 G̲E̲N̲E̲R̲A̲L̲
a) Purpose Statement. Describe the purpose of the
Subsystem Specification using the following as
a guide: The Subsystem Specification for (Project
Name) (Project Number) is written to fulfill the
following objectives:
1) To provide detailed definition of the Subsytem
functions.
2) To provide user operational and development
personnel details of the on-going analysis.
3) To define in detail the interfaces with other
systems/subsystems and to describe their facilities
b) Project References. This paragraph should summarize
the references applicable to the history and development
of the project. Specify the general nature of
the computer programs (tactical, inventory control,
war gaming, management information etc.)to be developed
and state the purpose and use of the system. Indicate
the project sponsor, user, and the operating center(s)
which will run the completed computer programs.
List all applicable documents by source or author,
reference number, title and security classification.
As a minimum the following should be specified:
1) Requirement Specification
2) Related System/Subsystem Specifications.
3) Other pertinent documentation or significant
correspondence not specified in the Functional
Description.
c) Terms and Abbreviations. List or include in an
appendix any terms, definitions, or acronymns unique
to this document and subject to interpretation.
Do not include item names or data codes.
4.2 S̲U̲M̲M̲A̲R̲Y̲ ̲O̲F̲ ̲R̲E̲Q̲U̲I̲R̲E̲M̲E̲N̲T̲S̲
This paragraph should summarize the system characteristics
and requirements, and should expand on the information
published in the Functional Description. Any changes
to the characteristics and requirements set forth in
the requirement specification (SRS) must be identified.
a) Subsystem Description. Provide a general description
of the Subsystem to establish a frame of reference
for the remainder of the document. Reference higher
order and parallel systems/subsystems and their
documentation as required. Provide a chart showing
the relationship of the users to the major components.
b) Systems/Subsystem Functions. Describe the subsystem
functions in both qualitative and quantitative
terms to show how these functions will satisfy
the requirements. While these descriptions may
be refined and in more detail, they must relate
both to the system functions and to the system/subsystem
environment described in SRS.
c) Accuracy and Validity. Describe the requirements
for subsystem accuracy. These requirements must
cover the following areas of concern:
1) Accuracy of mathematical calculations.
2) Accuracy of input data.
3) Accuracy of transmitted data.
d) Timing. Describe any requirements for timing on
the subsystem. The following requirements should
be considered:
1) Throughout time.
2) Response time to queries and for update of
data files.
3) Response time of major subsystem functions.
4) Sequential relationship of subsystem functions.
5) Priorities imposed by inputs or changes in
modes of operation.
6) Requirements for varying traffic load.
7) Sequencing and interleaving programs and systems
(including the ability to interrupt a program
without loss of data).
e) Flexibility. Describe the requirements for the
subsystem to deal with changing situations e.g.
operational changes, and interaction with new or
improved systems. Identify those components and
procedures which may be subject to change.
4.3 E̲N̲V̲I̲R̲O̲N̲M̲E̲N̲T̲
This section should expand on the SRS to reflect additional
analysis of any environmental changes. Those which
do not affect the scope of the project as described
in the SRS and are the result of ongoing analysis and
design should be explicitly identified within the appropriate
paragraphs of this section. The impact of these changes
on currently available invironmental components (equipment,
software, etc.) as well as on original estimates, functions
and environment should be discussed.
a) Equipment Environment. Describe the equipment
required for the operation of the subsystem, and
include a description of the equipment presently
available. Discuss the characteristics of any
additional equipment required. Relate the requirement
for equipment to the requirements stated in the
SRS. The following items should be described:
1) Processors(s) (number of each on/off line and
size of internal storage).
2) Storage media (number of disk units, tape units,
etc).
3) Input/output (I/O) devices (number of each
on/off line).
4) Communications net (line speeds).
b) Support Software Environment. Describe the support
software which will interact with the computer
programs being developed. Include both support
test software. Provide the nomenclature and documentation
references for each software system, subsystem,
and program. Indicate what languages (compiler,
assembler, program, query, etc), operating system,
Data Management System (DMS) will be used. This
description should expand on the information provided
in the SRS. The nature, status and implementation
date of any changes to support softare which will
impact on the computer programs being developed
must also be discussed.
c) Interfaces. Describe the interfaces with other
applications computer programs, including those
of other operational capabilities and from other
organizations. The individual interrace should
be related to the SRS and include the following:
1) Types of interface, such as operator control
of a terminal, program interfaces with other
programs.
2) Operational implications of data transfer,
including security requirements.
3) Requirements for transfer of data to and from
the subject system/subsystem and characteristics
of communications media/systems used.
4) Formats of interchanged data.
5) Interface procedures, including telecommunications
considerations.
6) Interface equipment
Describe subsystem specifications interfaced with other
subsystems in the same manner.
d) Security. Describe the classified components of
the subsystem, relating them to the SRS. Include
computer programs, inputs, outputs, and data bases.
e) Controls. This paragraph should describe the overall
subsystem controls, and will include counts, accumulated
counts, batch controls, etc. State if no specific
controls are to be established at the subsystem
level.
4.4 D̲E̲S̲I̲G̲N̲ ̲D̲E̲T̲A̲I̲L̲S̲
a) General Operating Procedures. This paragraph should
provide a general description of the system oprating
procedures, and will cover the load, start, stop,
recovery and restart procedures.
b) System Logical Flow. Describe the logical flow
of the subsystem in the form of high level charts.
A narrative presentation, when appropriate, may
be used to supplement the chart. The charts should
provide an intergrated presentation of the subsystem
dynamics, of entrances and exits, and of interfaces
with other computer programs. They should represent
all modes of operations, priorities, cycles and
special handling, and show data flow from input,
through the subsystem, to the generation of output.
c) System Data. Describe the inputs, outputs, and
data using the format below:
1) Inputs. Provide the following:
- Title and tag
- Format and acceptable range of values
- Number of items.
- Means of entry and input initiation procedures;
e.g. typewriter, card, tape, sensor, internal.
- Expected volume and frequency, including
special handling (such as queuing and priority
handling) for high density periods.
- Priority; e.g. routine, emergency.
- Sources, input form disposition of source
document.
- Security classification of input and individual
items
- Requirements for timeliness.
2) Outputs. Provide the following:
- Title and tag.
- Format to include headings, line spacing,
arrangement, totals, etc.
- Number of items.
- Preprinted form requirements
- Means of display; e.g. VDU, printer, typewriter,
projector, alarm type, internal.
- Expected volume and frequency including
special handling (such as queuing and priority
handling) for high density periods.
- Priority; e.g. routine, emergency
- Timing requirements e.g. response time.
- Requirements for accuracy.
- User recipients and use of displays, such
as notification, trends, or briefings.
- Security classification of output and individual
items.
3) Data Base, Each data file, table dictionary,
or directory will be described as follows:
- Title and tag.
- Description of content.
- Number of records or entries
- Storage, to include type of storage, amount
of storage and, if known, beginning and
ending addressees.
- Classification
- Data retention
d) Program Description. Paragraphs 4d(1) through
4d(n) should describe the functions (related to
paragraph 2b of the Subsystem Specification) of
the computer programs in subsystem.
