J-STD-0 16-1 99 5

Page 178

J.2.3 Contents of the Software Center Operator Manual (SCO

SOFTWARE CENTER OPERATOR MANUAL (SCO

Scope
1.1 Identification
1.2 System overview
1.3 Document overview
Referenced documents
Software summary
3.1 Software application
3.2 Software inventory
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
Installation and setup
Description of runs
5.1 Run inventory
5.2 Phasing
.3 Diagnostic procedures
Error messages

5.5.x. 1 Control input

5.5.x.2 Run manage

tions

pi:
 J-STD-0 16-7 995
Page 179

Software Center Operator Manual (SCOM) -- lconrinuedl

. . into the following subclauses.

1. Sco~e. This clause should be divided

1.1 Identification. This subclause shall contain a full identification of the system and
software to which this document applies, including, as applicable, identification numberk),
titie(s1, abbreviationLs), version numberk), and release number(s1.

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 system 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 sourcf
of all documents referenced in this manual.

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
Jses of the software. Capabilities, operating improvements. and benefits expected from its
Jse shall be described.

3.2 Software inventory. This subclause shall identify all software files, including
latabases and data files, that are required t o be installed for the software t o operate. The
dentification shall include security and privacy protection considerations for each file and
dentification of the software necessary to continue or resume operation in case of an
bmergency.

3.3 Software environment. This subclause shall identffy the hardware, software, manual
,perations, and other resources needed t o install and operate the software. Included, as
~pplicable,shall be identification of:

a. Computer equipment that is required t o be present, including amount of memory

needed, amount of auxiliary storage needed, and peripheral equipment such as
terminals, printers, and other input/output devices
b. Communications equipment that is required t o be present
c. Other software th be present, such a are,
operating system a files, urilities, p re
referenced, creat
to resume operation in the event
J-STD-019-1995
Page 180

Software Center Operator Manual (SCOM) -- fcontinuedl

3.4 Software oraanization and overview of ooeration. This subdause shall provide a
brief description of the organization and operation of the software from the operator's point
of view. The description shall include, as applicable:

Logical components of the software, from the operator's point of view, and an
overview of the purposeloperation of each component

Types of inputlaccess that can be made t o the software and the software's
response to each type

The reports and other output that are produced b y the software, including security
and privacy protection considerations for each

Typical run times and factors that affect them

Organization of software operation into runs. This description shall use a chart, if
applicable. showing how the different operations are interrelated. If sets of runs are
grouped by time periods or cycles. each set of integrated operations required on a
daily, weekly, etc., basis shall be presented. If runs may be grouped logically by
organizational level, the groups of runs that can be performed by each organizational
level such as headquarters or central office processing, field office processing, etc.,
shall be presented.

Any system restrictions, waivers of operational standards, information oriented

toward specific support areas (for example, library, small computer and teleproces-
sing support, interfaces with other systems), or other special aspects of processing

General description of the communications functions and processes of the software,

including, as applicable, a diagram of the communications network used in the
system

Continaencies and alternate states and modes of ooeration. This subclause shall
?xplain the differences in software operation at times of emergency and in various states
and modes of operation, if applicable.

3.6 Securitv and orivacv orotection. This subclause shall contain an overview of the
;ecurity and privacy protection considerations associated with the software. A warning
;hall be included regarding making unauthorized copies of software'or documents, if
~ppiicable. ..

1.7 Assistance and aroblern reooninq. is +ubclause shall ident points of canra
ind procedures to be followed to obtain assistance and report problems encountered in
perating the software.
 J-STD-0 16-1995
Page 18 1

Software Center Operator Manual (SCOM) -- (continued)

5. Descriotion of runs. This clause should be divided into the following subclauses t o
provide a description of the runs t o be performed. Safety precautions, marked by
WARNING or CAUTION, shall be included where applicable.

5.1 Run inventory. This subclause shall provide a list of the runs t o be performed,
identifying the software and the jobs that make up each run. It shall include a brief
summary of the purpose of each run and shall relate the list t o the run descriptions included
in the remainder of this clause.

5.2 Phasing. This subclause shall describe acceptable phasing of the software into a
logical series of operations. A run may be phased t o permit manual or semiautomatic
checking of intermediate results, t o provide the user with intemediate results for other
purposes, or t o permit a logical break if higher priority jobs are submitted. An example of
the minimum division for most systems would be edit, file update. and report preparation.

5.3 Diaanostic procedures. This subclause shall provide the setup and execution
procedures for any software diagnostics. Included shall be procedures for validation and
trouble shooting. All parameters (both input and output), codes, and range values for diag-
nostic software shall be explained.

5.4 Error messaaes. This subclause shall list all error messages output b y the software,
along with the meaning and corresponding correction procedure for each message.

5.5 Descriotion of each run. This subclause should be divided into the following.

5.5.x Run description for (run name or identifierl. This subclause shall identify a run and
should be divided into the following t o describe the run.

j.5.x.lControl inout. This subclause shall provide a listing of the run stream of job control
xatements needed t o initiate the run.

5.5.x.2 Run manaaement information. This subclause shall provide the information needed
o manage the run including, as appiicable:

a. Peripheral and resource requirements

b. Security and privacy protenion considerations
c. Method of initiation, such as on request, after another run, or at a predetermined
time
d. Estimated run time
e. Required turnaround ti
f. Messages and respons
g. Procedures for taking
J-STD-076-1995
Page 182

-- (continued)
I 5.5.x.3
Software Center Operator Manual (SCOM)

Inout-out~utfiles. This subclause shall provide information about the files and
databases that serve as input to or that are created or updated by the run. Included for
each shall be information such as name. security and privacy protection, recording medium,
retention schedule, and disposition.

5.5.x.4 Outout reoort~. This subclause shall provide information about the repons that are
produced during the run. Included for each repon shall be the following inforrnation, as
applicable: report identifier, product control number, repon control symbol, title, security
and privacy protection, media (e.g.. hard copy, magnetic tape), volume of report, number of
copies. and distribution of copies.

5.5.x.5 Re~roducedo u t ~ u re~orts.

t This subclause shall provide information about
computer-generated repons that are subsequently reproduced by other means. lncluded for
each repon shall be inforrnation such as report identification, security and privacy
protection, reproduction technique, paper size, binding method, number of copies, and
distribution of copies.

5.5.x.6 Procedures for restart/recoverv and continuitv of o~erations. This subclause shall
provide procedures to be followed by operator personnel concerning restanlrecovery in the
event of a system failure and for continuity of operations in the event of emergencies.

6. Notes. This clause shall contain any general information that aids in understanding this
document (e-g., background inforrnation, glossary, rationale). This clause shall include an
alphabetical listing of ali acronyms, abbreviations, and their meanings as used in this
document and a list of terms and definitions needed to understand this document.

A. Annexes. Annexes may be used to provide information published separately for

convenience in document maintenance (e-g., charts, classified data). As applicable, each
annex shall be referenced in the main body of the document where the data would normally
have been provided. Annexes may be bound as separate.documents for ease in handling.
Annexes shall be lettered alphabetically (A. B, etc.).