J-STD-O
1 6-1 995
Page 170
J.2.2 Contents of the Software inpu+,i'Ou"+;4e;:t*
SOFTWARE INPUTIOUTPUT MANUAL (SIOM)
Contents
Scope
1.1 Identification
1.2 System overview
1.3 Document overview
Referenced documents
Software summary
3.1 Software application
3.2 Software inventor ;
3.3 Software environment
3.4 Software organization and overview of operation
3.5 Contingencies and alternate states and modes of operation
3.6 Security and privacy protection
3.7 Assistance and problem reporting
Using the software
4.1 Initiation procedures
4.2 Description of input
.2.1 Input conditions
4.3.1 General description
Output formats
4.3.3 Sample o
J-STD-0 1 6-1995
Page 17 1
Software InputlOutput Manual (SIOM) -- (continued)
5. Query procedures
5.1 Databaseldata file format
5.2 Query capabilities
5.3 Query preparation
5.4 Control instructions
6. User terminal processing procedures
6.1 Available capabiiiies
6.2 Access procedures
6.3 Display, updates. and retrieval procedures
6.4 Recovery and error correction procedures
6.5 Termination procedures
7. Notes
A. Annexes
J-STD-016-1995
Page 172
Software Input/Output Manual (SIOM) - fcontinuedl
1. Sco~e. This clause should be divided into the following subclauses.
1.1 Identification. This subciause shall contain a full identification of the system and the
software to which this document applies, including, as applicable, identification numberts),
title(s1, abbreviationki), version number(s1, and release numberk).
1.2 Svstem overview. This subclause shall briefly state the purpose of the system and
the software to which this document applies. It shall describe the general nature of the
system and software; summarize the history of svstem development, operation, and
maintenance; identify the project sponsor, acquirer, user, developer, and maintenance
organizations; identify current and planned operating sites; and list other relevant
documents.
1.3 Document overview. This subclause shall summarize the purpose and contents of
this manual and shall describe any security or privacy protection considerations associated
with its use.
2. Referenced documents. This clause shall list the number, title, revision, date, and source
of all documents referenced in this manual.
I 3. Software summary. This clause should be divided into the following subclauses.
3.1 Software a ~ ~ l i c a t i o nThis
. subclause shall provide a brief description of the intended
uses of the software. Capabilities, operating improvements, and benefits expected from its
use shall be described.
3.2 Software inventory. This subclause shall identify the software files, if any, including
databases and data files, that the user is responsible for requesting in order t o access the
software described in this manual. The identification shall include security and privacy
protection considerations for each file and identification of the software necessary t o
continue or resume operation in case of an emergency.
' 3.3 Software environment. This subclause shall identify the hardware, software, manual
operations, and other resources needed to access and use the software. This subciause
shall be based on the assumption that the software is installed in a computer center or other
centralized or networked environment and shall focus on the resources that a user is
required to have to access and use the software in that environment. Included, as
applicable, shall be identification of:
a. Computer equipment that is required to be present, such as terminals, printers, or
other input/output devices
Page 173
Software tnput/Output Manual (SIOM) -- lconrinuedl
3.4 Software oraanization and overview of oeeration; This subclause shall provide a
brief description of the organization and operation of the software from the user's point of
view. The description shall include, as applicable:
a. Logical components of the software, from the user's point of view, including
databases and data files the user can access, Database Management Systems
IDBMSs), and communications paths, and an overview of the purpose/operation of
each component
b. Performance characteristics that can be expected b y the user, such as:
7 ) Type, volume, rate of input accepted
2 ) Type, volume, accuracy, rate of output the software can produce
3) Typical response time and factors that affect it
4) Typical processing time and factors that affect it
5) Limitations, e.g, restrictions on what data may be queried and from what
location
6) Error rate that can be expected
7 ) Reliability that can be expected
c. Relationships of the functions performed b y the software with interfacing systems
and with the organizations or stations that are sources of input or recipients of
output
d. Supervisory controls that can be implemented (such as passwords) t o manage the
software
3.5 Continaencies and alternate states and modes of oeeration. This subclause shall
sxpiain the differences in what the user will be able t o do with the software at times of
tmergency and in various states and modes of operation, if applicable.
3.6 Securitv and orivacv cirotection. This subclause shall contain an overview of the
;ecurity and privacy protection considerations associated with the software. A warning
rhall be included regarding making unauthorized copies of software or documents, if
~pplicable.
1.7 Assistance and ~ r o b i e mreeortinq. This subclause shall identify points of contact
ind procedures t o be followed t o obtain assistance and repon problems encountered in
sing the software.
.. Usina the software. This clause should be ivided into the foll ing subclauses t o
tescribe how t o prepare input to, and inte utput from, the s are. If the softw
as a query capability, this subciause shall reference clause 5 for a description of this
apabiiiry. if the software can be accesse via terminal, this su clause shall reference
lauses 6 through n t o describe terminal
J-STD-O 1 6- 1995
Page 174
-- (continued)
1I
Software Input/Output Manual (SIOM)
4.2 Descriotion of inout. This subclause should be divided into the following.
4.2.1 lnout conditions. This subclause shall describe the conditions to be observed in
preparing each type or class of input to the software. The conditions shall include the
following, as applicable:
a. Reason for input, such as normal status report. need t o update data
b. Frequency of input, such as monthly, on demand
c. Origin of input, such as the organization or station authorized to generate the input
d. Medium of input, such as magnetic tape
e. Related input that is required to be entered at the same time as this input
f. Other applicable information, such as priority; security and privacy protection
considerations
4.2.2 l n ~ uformats.
t This subclause shall illustrate the layout formats to be used in the
preparation of input to the software and shall explain the information that may be entered in
the various clauses and lines of each format.
4.2.3 Comoosition rules. This subclause shall describe any rules and conventions that are
required to be observed t o prepare input. The rules of syntax. usage of punctuation, etc.,
shall be explained. The rules shall include the following, as applicable:
a. Input transaction length, such as 100 characters maximum
b. Format conventions, such as all input items are required t o be left-justified
c. Labeling, such as usage of identifiers to denote major data sets to the software
d. Sequencing, such as order and placement of items in the input
e. Punctuation, such as spacing and use of symbols (virgule, asterisk, character
combinations, etc.) to denote stan and end of input, of data groups, and of fields
f. Restrictions, such as rules forbidding use of particular characters or parameter sets
4.2.4 lnout vocabulary. This subclause shall explain the legal character combinations or
codes that are required to be used to prepare input. An annex may be provided containin
an ordered listing of these codes.
4.2.5 Samole inout. This subclause shall provide examples that iliustrate and explain each
type or class of input acceptable by the software. Included shall be information on the
following types of input, as applicable:
J-STD-016-1995
Page 175
Software InputlOutput Manual (SIOM) -- fconrinuedl
4.3 Descrbtion of oumut. This subclause should be divided into the following.
4.3.1 General descriotion. This subclause shall provide the following informarion, as
applicable, for each type or class of output:
a. Reasons why the output is generated
b. Frequency of the output. such as monthly, on demand
c. Any modifications or variations of the basic output that are available
d. Media, such as printout, display screen, tape
e. Location where the output will appear, such as in the computer area or remotely
f. Any additional characteristics, such as priority, security and privacy protection
considerations, associated output that complements the information in this output
4.3.2 Outwut formats. This subclause shall illustrate and explain the layout of each type o
:lass of output from the software. The following aspens shall be explained, as applicable:
a. Security and privacy protection markings
b. Data that may appear in headers
c. Information that may appear in the body or t e n of the output, including column
headings and subsets or clauses in the output format
d. Data that may appear in trailers
e. Additional characteristics, such as the meaning of special symbols
1.3.3 Samwle o u t ~ a . This subclause shall provide illustrations of each type or class of
~utputfrom the software. A description of each sample shall be provided, including, as
~pplicable:
a. Meaning and use of each column, entry, etc.
b. Source, such as extracted from database, calculated
c. Characteristics, such as when omitted, range of values, unit of measure
..3.4 O u t ~ uvocabulary.
t This subclause shall describe any codes or abbreviations that
ppear in the output that differ from those used in the input described in subclause 4.2.4.
.4 Use of 0ut~t.q. This subclause shall explain the use of the output b y he opera~isnal
rea or activity that receives it.
.5 Recoverv and error correction wrocedures. shall list the enor cod
enerated by the software, give their meanings, and describe the corrective actions t o be
)ken by the user. Also included shall be the procedures to be followed b y the user with
!spect to restart, recovery, and continuity of ope tions in the event of emergencies.
I Software InputIOutput Manual (SIOM) -- (continued)
5. Querv ~rocedures. This clause shall be prepared for software with a query capability. It
should be divided into the following subclauses.
5.1 Databaseldata file format. This subclause shall provide a user's view of the format
and content of each database and data file that can be queried, Information such as the
following shall be provided for each data element, as applicable:
a. Data element name
b. Synonymous names
c. Definition
d. Format
e. Range and enumeration of values
I f. Unit of measurement
( g. Data item names. abbreviations, and codes
5.2 Querv ca~abilities. This subclause shall identify and describe the preprogrammed
and ad hoc query capabilities provided by the software.
5.3 Querv oreoaration. This subclause shall provide instructions for preparing queries.
5.4 Control instructions. This subclause shall provide instructions for the sequencing of
runs and other actions necessary to extract responses t o query requests. These instructions
shall include control statemenrs that may be required by the computer system or software.
6. User terminal arocessin~orocedures. This clause should be divided into the following
subclauses to provide the user with information on the use of terminals to accomplish
processing. If the procedures are complicated or extensive, clauses 7 through n may be
added in the same subclause structure as this clause and with titles meaningful to the
clauses selected. The organization of the document will depend on the characteristics of
the software being documented. For example, clauses might be based on the organizations
in which users work, their assigned positions, work sites, or the tasks they are required t o
perform. For other software, it may be more appropriate to have clause 6 be a guide t o
menus, clause 7 be a guide to the command language, and clause 8 be a guide to functions.
Detailed procedures are intended to be presented in subclauses 6.2 through 6.5. Depending
on the design of the software, the subclauses might be organized on a function-by-function,
menu-by-menu, transaction-by-transaction, or other basis. Safety precautions, marked by
WARNING or CAUTION, shall be included where applicable.
ribe in general terms the capabilities
ate of data through terminal operations.
J-STD-016-1995
Page 177
Software Input/Output Manual (SIOM) -- (conrinuedl
6.3 Dis~lav,uodares. and retrieval orocedures. This substause should be divided into
subclauses to provide the step-by-step procedures necessary to produce the displays,
updates, and retrievals that are available through the use of a terminal. Each procedure
shall include the name of the operation, input formats, and sample responses, as applicable.
6.4 Recoverv and error correction ~rocedures. This subclause shall identify error
messages that may be displayed and shall indicate their meanings and any corrective actions
that should be taken. Also included shall k - any procedures t o be followed by the user with
respect t o restart, recovery, and continuity of op.- dlons in the event of emergencies.
6.5 Termination orocedures. This subclause shall present the sequence of steps
necessary to terminate the processing.
7. Notes. This clause shall contain any general information that aids in understanding this
document (e.g., background information, glossary, rationale). This clause shall include an
alphabetical listing of ail acronyms, abbreviations, and their meanings as used in this
document and a list of terms and definitions needed to understand this document. If clause
6 has been expanded into clause(s) 7, ..., this clause shall be numbered as the next clause
following clause n.
A. Annexes. Annexes may be used to provide information published separately for
zonvenience in document maintenance (e.g., cham, classified data). As applicable, each
annex shall be referenced in the main body of the document where the data would normally
lave been provided. Annexes may be bound as separate documents for ease in handling.
4nnexes shall be lettered alphabetically (A, 0, etc.).