top - download
⟦611e67481⟧ Wang Wps File
Length: 6622 (0x19de)
Types: Wang Wps File
Notes: Software Doc. Std.
Names: »0134A «
Derivation
└─⟦84647c47a⟧ Bits:30005817 8" Wang WCS floppy, CR 0014A
└─ ⟦this⟧ »0134A «
WangText
…02…SD/STD/008
…02…SVO/801010…02…#
SOFTWARE MODULE DOCUMENTATION STANDARD
…02……02…GENERAL
T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲
1 SCOPE ........................................
4
2 PURPOSE ......................................
4
3 ORGANIZATION .................................
4
3.1 SYNOPSIS .................................
4
3.1.2 Tayloring of Synopsis ................
4
3.2 LAYOUT ...................................
5
3.3 CONTENT ..................................
5
3.3.1 Language Style .......................
5
4 DIAGRAMS .....................................
6
4.1 HIERARCHICAL OVERVIEW CHART ..............
6
4.2 INPUT - PROCESS - OUTPUT CHARTS ..........
7
4.3 FLOWGRAMS ................................
7
4.4 DATA CHARTS ..............................
7
A̲P̲P̲E̲N̲D̲I̲X̲ ̲A̲
A.1 GENERAL ..................................
2
A.2 SUMMARY OF REQUIREMENTS ..................
3
A.3 ENVIRONMENT ..............................
4
A.4 DESIGN DETAILS ...........................
6
A̲P̲P̲E̲N̲D̲I̲X̲ ̲B̲
B.1 GENERAL FORMAT ...........................
2
B.2 DATA ITEMS AND DATA GROUPS ...............
2
B.3 ARROWS ...................................
5
B.4 PROCESS SECTION .......................... 17
A̲P̲P̲E̲N̲D̲I̲X̲ ̲C̲
A̲P̲P̲E̲N̲D̲I̲X̲ ̲D̲
D.1 BIT LEVEL DIAGRAMS .......................
1
D.2 WORD LEVEL DIAGRAMS ......................
1
D.3 CHARACTER LEVEL DIAGRAMS .................
2
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 units of module or lower levels (see system
design guideline for definition of module level).
3̲ ̲ ̲O̲R̲G̲A̲N̲I̲S̲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 D. This standard is found as Appendix A
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 consideraion in a specification is its
technical essence, and this should be presented in
a language free of vague and ambiquous 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.
3.3.2 D̲i̲a̲g̲r̲a̲m̲s̲
A series of diagramtic aids shall be used extensively
to enhance the understandability of the text. These
aids, their form and use will be described in detail
in chapter 4.
Note that although diagrams in some cases may constitute
the major part of a section they shall still be considered
an aid for the text and never a replacement of it.
4̲ ̲ ̲D̲I̲A̲G̲R̲A̲M̲S̲
4.1 H̲I̲E̲R̲A̲R̲C̲H̲I̲C̲A̲L̲ ̲O̲V̲E̲R̲V̲I̲E̲W̲ ̲C̲H̲A̲R̲T̲
A major point in describing the processing of a software
module is the breakdown of the processing into subprocesses
which again may be broken down into sub-subprocesses
through several levels.
To describe the interrelationship between the partial
processes and define their level in the breakdown hierarchy
an overview chart shall be used.
An example of an overview chart is shown in fig. 1.
In this chart each partial process is represented by
a box containing a descriptive title of the process
and a reference to the paragraph in which it is further
described.
4.2 I̲N̲P̲U̲T̲ ̲-̲ ̲P̲R̲O̲C̲E̲S̲S̲ ̲-̲ ̲O̲U̲T̲P̲U̲T̲ ̲C̲H̲A̲R̲T̲S̲
For each of the partial processes defined in the overview
chart shall be produced a chart showing the relation
between the inputs, the outputs, and the subprocesses
within the process.
The standard for those charts are shown in Appendix
B which is an extract from IBM's HIPO manual.
Note that the following restriction to the normal HIPO
concept must be adhered to:
- The process box shall only contain a listing of
the subprocesses, ordered as closely as possible
to the sequence in which they will be performed.
- No attempt shall be made to show the logic relation
or control flow between subprocesses.
4.3 F̲L̲O̲W̲G̲R̲A̲M̲S̲
For each of the partial processes defined in the overview
chart shall be produced a flowgram showing the logical
interrelation between the subprocesses.
These flowgrams shall be produced in accordance with
the rules given in Appendix C. (In preliminary issue
is used an offprint of an article in Electronic design).
4.4 D̲A̲T̲A̲ ̲C̲H̲A̲R̲T̲S̲
In the sections of specification containing data descriptions,
this is mainly
section 3b Interfaces
3c Storage
4b Inputs
4c Outputs
shall be used Data Charts to show the layout of data
items of any complexity higher than single words or
simple arrays.
These Data Charts shall have a format as shown in Appendix
D.
