FACULTY

OF
INFORMATION
AND
COMMUNICATION TECHNOLOGY

NATIONAL DIPLOMA: COMPUTER SYSTEMS

ENGINEERING

INTELLIGENT INDUSTRIAL SYSTEMS:

IDC30BI/PJD301B

USER MANUAL

PROJECT TITLE:……………………………………………………………………

LECTURER NAME……Muwanguzi Mark Ntume and Chunling Du……………

STUDENTS NAME:……………………………………............................... …

STUDENTS NUMBER…………………………………………………………

EMAIL ADDRESS………………………………………………………………

CONTACT NUMBERS …………………………………………………………

Page 1 of 9
TABLE OF CONTENTS
1. SCOPE...........................................................................................................................................3
2. REFERENCED DOCUMENTS....................................................................................................3
3. SOFTWARE SUMMARY............................................................................................................3
4. ACCESS TO THE SOFTWARE...................................................................................................4
5. PROCESSING REFERENCE GUIDE..........................................................................................6
6. QUERY PROCEDURES...............................................................................................................7
7. NOTES..........................................................................................................................................8
8. REFERENCE................................................................................................................................8

Page 2 of 9
 1. SCOPE

1.1 Identification. This paragraph shall contain a full identification of the system and the
software to which this document applies, including, as applicable, identification number(s),
title(s), abbreviation(s), version number(s), and release number(s). Identification must
include the operating system platform(s) to which this document applies.

1.2 System overview. This paragraph 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 support agencies; identify current
and planned operating sites; and list other relevant documents.

1.3 Document overview. This paragraph shall summarize the purpose and contents of this
manual and shall describe any security or privacy considerations associated with its use.

2. REFERENCED DOCUMENTS
This section shall list the number, title, version/revision, and date of all documents referenced in this
manual. This section shall also identify the source for all documents not available through normal
Government stocking activities.

3. SOFTWARE SUMMARY
1.4 Software application. This paragraph shall provide a brief description of the intended
uses of the software or hardware. Capabilities, operating improvements, and benefits
expected from its use shall be described.

1.5 Software inventory. This paragraph shall identify all software files, including databases
and data files that must be installed for the software to operate. Identify software necessary
to continue/resume operation in case of emergency. The identification shall include security
and privacy considerations for each file and identification of the software necessary to
continue or resume operation in case of an emergency.

1.6 Software environment. This paragraph shall identify the hardware, software, equipment,
manual operations, and other resources needed for a user to install and run the software.
Included, as applicable, shall be identification of:

a. Computer equipment that must 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 must be present
c. Other software that must be present, such as operating systems, databases, data
files, utilities, and other supporting systems
d. Forms, procedures, or other manual operations that must be present
e. Other facilities, equipment, or resources that must be present

Page 3 of 9
1.7 Software organization and overview of operation. This paragraph 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
(DBMSs), and communications paths, and an overview of the purpose/operation of
each component
b. Performance characteristics that can be expected by the user, such as:
1) Types, volumes, rate of inputs accepted
2) Types, volume, accuracy, rate of outputs that the software can produce
3) Typical response time and factors that affect it
4) Typical processing time and factors that affect it
5) Limitations, such as number of events that can be tracked
6) Error rate that can be expected
7) Reliability that can be expected
c. Relationship of the functions performed by the software with interfacing systems,
organizations, or positions
d. Supervisory or security controls that can be implemented (such as passwords) to
manage the software

1.8 Contingencies and alternate states and modes of operation. This paragraph shall
explain differences in what the user will be able to do with the software at times of
emergency and in various states and modes of operation, if applicable.

1.9 Security and privacy. This paragraph shall contain an overview of the security and
privacy considerations associated with the software. A warning shall be included regarding
making unauthorized copies of software or documents, if applicable.

1.10 Assistance and problem reporting. This paragraph shall identify points of contact and
procedures to be followed to obtain assistance and report problems encountered in using the
software.

4. ACCESS TO THE SOFTWARE

This section shall contain step-by-step procedures oriented to the first time/occasional user. Enough
detail shall be presented so that the user can reliably access the software before learning the details
of its functional capabilities. Safety precautions, marked by WARNING or CAUTION, shall be
included where applicable.

1.11

4.1.1 Access control. This paragraph shall present an overview of the access and security
features of the software that are visible to the user. The following items shall be included, as
applicable:

a. How and from whom to obtain a password

b. How to add, delete, or change passwords under user control
c. Security and privacy considerations pertaining to the storage and marking of
output reports and other media that the user will generate

4.1.2 Installation and setup. This paragraph shall describe any procedures that the user
must perform to be identified or authorized to access or install software on the equipment, to

Page 4 of 9
 perform the installation, to configure the software, to delete or overwrite former files or data,
and to enter parameters for software operation.

1.12 Initiating procedure. This paragraph shall provide step-by-step procedures for beginning
work, including any options available. A checklist for problem determination shall be
included in case difficulties are encountered.

1.13 Description of inputs.

4.3.1 Input conditions. This paragraph 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 to 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 inputs that are required to be entered at the same time as this input
f. Other applicable information, such as priority; security and privacy
considerations

4.3.2 Input formats. This paragraph shall illustrate the layout formats to be used in the
preparation of inputs to the software and shall explain the information that may be entered in
the various sections and lines of each format.

4.3.3 Composition rules. This paragraph shall describe any rules and conventions that
must be observed to prepare inputs. 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 must 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 start and end of input, of data groups, and of
fields
f. Restrictions, such as rules forbidding use of particular characters or parameter
sets

4.3.4 Input vocabulary. This paragraph shall explain the legal character combinations or
codes that must be used to prepare inputs. An appendix may be provided containing an
ordered listing of these codes.

4.3.5 Sample inputs. This paragraph shall provide examples that illustrate and explain
each type or class of input acceptable by the software. Included shall be information on the
following types of inputs, as applicable:

a. Headers denoting the start of input

b. Text or body of the input
c. Trailers denoting the end of input
d. Portions of the input that may be omitted
e. Portions of the input that may be repeated

Page 5 of 9
1.14 Description of outputs.

4.4.1 General description. This paragraph shall provide the following information, 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 is 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
considerations, or associated outputs that complement the information in this
output

4.4.2 Output formats. This paragraph shall illustrate and explain the layout of each type
or class of output from the software. The following aspects shall be explained, as applicable:

a. Security and privacy markings

b. Data that may appear in headers
c. Information that may appear in the body or text of the output, including
column
headings and subsets or sections in the output format
d. Data that may appear in trailers
e. Additional characteristics, such as the meaning of special symbols

4.4.3 Sample outputs. This paragraph shall provide illustrations of each type or class of
output from the software. A description of each sample shall be provided, including, as
applicable:

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

1.15 Recovery and error correction procedures. This paragraph shall list the error codes
generated by the software, give their meanings, and describe the corrective actions to be
taken by the user. Also included shall be the procedures to be followed by the user with
respect to restart, recovery, and continuity of operations in the event of emergencies.

1.16 Stopping and suspending work. This paragraph shall describe how the user can cease or
interrupt use of the software and how to determine whether normal termination or cessation
has occurred.

5. PROCESSING REFERENCE GUIDE

This section shall describe the functionality provided by and specify procedures for using the
software. The organization of the document will depend on the characteristics of the software being
documented. If procedures are complicated or extensive, additional Sections 6, 7, ... may be added
in the same paragraph structure as this section and with titles meaningful to the sections selected. For
example, one approach is to base the sections on the organizations in which users work, their
assigned positions, their work sites, or the tasks they must perform. For other software, it may be
more appropriate to have Section 5 be a guide to menus, Section 6 be a guide to the command
language used, and Section 7 be a guide to functions. Detailed procedures are intended to be

Page 6 of 9
presented in subparagraphs of paragraph 5.3. Depending on the design of the software, the
subparagraphs 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. Whatever the method of organization, the format for presenting
information must have a consistent style.

1.17 Capabilities. This paragraph shall briefly describe the interrelationships of the transactions,
menus, functions, or other processes in order to provide an overview of the use of the
software.

1.18 Conventions. This paragraph shall describe any conventions used by the software, such as
the use of colors in displays, the use of audible alarms, the use of abbreviated vocabulary,
and the use of rules for assigning names or codes.

1.19 Processing procedures. This paragraph shall explain the organization of subsequent
paragraphs, e.g., by function, by menu, by screen. Any necessary order in which procedures
must be accomplished shall be described.

1.20 Aspect of software use. The title of this paragraph shall identify the function, menu,
transaction, or other process being described. This paragraph shall describe and give options
and examples, as applicable, of menus, graphical icons, data entry forms, user inputs, inputs
from other software or hardware that may affect the software's interface with the user,
outputs, diagnostic or error messages or alarms, and help facilities that can provide on-line
descriptive or tutorial information. The format for presenting this information can be adapted
to the particular characteristics of the software, but a consistent style of presentation shall be
used, i.e., the descriptions of menus shall be consistent; the descriptions of transactions shall
be consistent among themselves.

1.21 Related processing. This paragraph shall identify and describe any related batch, off-line, or
background processing performed by the software that is not invoked directly by the user and
is not described in paragraph 5.3. Any user responsibilities to support this processing shall
be specified.

1.22 Data backup. This paragraph shall describe procedures for creating and retaining backup
data that can be used to replace primary copies of data in event of errors, defects,
malfunctions, or accidents.

1.23 Recovery from errors, malfunctions, and emergencies. This paragraph shall present detailed
procedures for restart or recovery from errors or malfunctions occurring during processing
and for ensuring continuity of operations in the event of emergencies.

1.24 Messages. This paragraph shall list, or refer to an appendix that lists, all error messages,
diagnostic messages, and information messages that can occur while accomplishing any of
the user's functions. The meaning of each message and the action that should be taken after
each such message shall be identified and described.

1.25 Quick-reference guide. If appropriate to the software, this paragraph shall provide or
reference a quick-reference card or page for using the software. This quick-reference guide
shall summarize, as applicable, frequently-used function keys, control sequences, formats,
commands, or other aspects of software use.

Page 7 of 9
 6. QUERY PROCEDURES
1.26 Database/data file format. This paragraph shall provide a user's view of the format and
content of each database and data file that can be queried. Figure 1 provides an example.
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
f. Unit of measurement
g. Data item names, abbreviations, and codes

1.27 Query capabilities. This paragraph shall identify and describe the preprogrammed and ad
hoc query capabilities provided by the software.

1.28 Query preparation. This paragraph shall provide instructions for preparing queries. Figure 3
shows an example of the format for a preprogrammed query.

1.29 Control instructions. This paragraph shall provide instructions for the sequencing of runs
and other actions necessary to extract responses to query requests. These instructions shall
include control statements that may be required by the computer system or software.

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

8. REFERENCE

Page 8 of 9
A. APPENDIXES

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 in handling. Appendixes shall be lettered alphabetically (A,
B, etc.).

Page 9 of 9