top - download
⟦4cb722920⟧ Wang Wps File
Length: 6403 (0x1903)
Types: Wang Wps File
Notes: Guideline to Users Guides
Names: »0404A «
Derivation
└─⟦1304ed705⟧ Bits:30006073 8" Wang WCS floppy, CR 0030A
└─ ⟦this⟧ »0404A «
WangText
…02…APPENDIX B
…02…801202…02……02…#
GUIDELINE TO DEVELOPMENT
OF CAMPS USERS GUIDES…02… …02…CAMPS
GUIDELINE TO DEVELOPMENT…01…OF CAMPS USERS GUIDES…86…1 …02… …02… …02… …02…
T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲
1 SCOPE..........................................
1.1 GENERAL......................................
2 USERS GUIDE....................................
2.1 TABLE OF CONTENTS AND LIST OF ILLUSTRATION...
2.2 INTRODUCTION.................................
2.2.1 Scope......................................
2.2.2 General....................................
2.3 SYNTAX SPECIFICATION.........................
2.4 OPERATING PROCEDURES.........................
2.5 MESSAGE HANDLING.............................
2.6 ERROR MESSAGES...............................
2.7 WARNINGS.....................................
2.8 APPENDIX.......................................
3 SUPERVISOR AND ASSISTANTS GUIDE................
3.1 GENERAL......................................
4 OPERATORS GUIDE................................
4.1 GENERAL
5 CSSI GUIDE.....................................
1 S̲C̲O̲P̲E̲
The scope of this description is to outline the input
to produce software guides for personel operating and
using the CAMPS system, thus defining the milestones
in the "MILESTONE TRACKING SYSTEM".
1.1 G̲E̲N̲E̲R̲A̲L̲
The guides to be produced include the following types:
a) User Guide. For personel in the staff cells
b) Operator Guide For the computer operator at the
maintenance position
c) Supervisor and
Assistants Guide For the supervisor and his assi-
stants
d) CSSI Guide For CSSI Personel
Each of the Guides are selfcontained units, i.e. all
information concerning each of the groups should be
included in the appropriate guide.
Each of the Guides should be made with the following
in mind:
What kind of information does the first-time user need:
a) To get familiar with the basic idea and functions
of the CAMPS system?
b) To define his own tasks in connection with the
system?
c) Hardware operation?
d) To get into contact with the system, eventually
to restart or cold start it?
e) To handle the various tasks assigned to him?
f) To overcome "pilot-errors"?
g) To establish malfunctions of the system?
h) To finish contact with the system in the appropriate
way.
To cover the above mentioned questions, the following
guidelines could be used for the production of the
different Guides.
2 U̲S̲E̲R̲S̲ ̲G̲U̲I̲D̲E̲
2.1 T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲ ̲A̲N̲D̲ ̲L̲I̲S̲T̲ ̲O̲F̲ ̲I̲L̲L̲U̲S̲T̲R̲A̲T̲I̲O̲N̲
should be included in front of the Guide.
2.2 I̲N̲T̲R̲O̲D̲U̲C̲T̲I̲O̲N̲
2.2.1 S̲C̲O̲P̲E̲
The scope of the Guides should include:
a) who is the guide assigned to
b) what is it used for
c) where should it be used
2.2.2 G̲e̲n̲e̲r̲a̲l̲
General information should include:
a) an overall description (with the applicable block
diagrams) of the CAMPS System.
b) a description of the tasks covered in the Guide.
c) how the Guide is used
d) other general information
2.3 S̲Y̲N̲T̲A̲X̲ ̲S̲P̲E̲C̲I̲F̲I̲C̲A̲T̲I̲O̲N̲S̲
This sections contains:
a) Syntax (diagrams, if used)
b) Syntax conventions
c) Syntax variables
d) other
2.4 O̲P̲E̲R̲A̲T̲I̲N̲G̲ ̲P̲R̲O̲C̲E̲D̲U̲R̲E̲S̲
Should include:
a) User Identification
b) Station Identification
c) Signing in and out
d) How to enter data
e) System responses
f) Other
2.5 M̲E̲S̲S̲A̲G̲E̲ ̲H̲A̲N̲D̲L̲I̲N̲G̲
This section should be divided into logical subsections,
eventual
a) Message Preparation
b) Message Release
c) Message Reception
Each subsection should begin with an overview covering
the different functions in alphabetical order.
Then the subsections should work through all the functions
explaining what to do and how to do it, followed up
by appropriate and covering example
May be the simplest and most understandable way to
do this would be to:
a) Show the actual screen form
b) List the possible syntax variation (eventually
in a syntax diagram)
c) Explain special options
d) Show a few applicable examples how to perform the
specific function
e) List possible error-messages and warnings and how
to procede from there.
2.6 E̲R̲R̲O̲R̲ ̲M̲E̲S̲S̲A̲G̲E̲S̲
This section should contain:
a) A list of all Error Messages
b) The format of each of them
c) What to do to correct mistakes in each case.
2.7 W̲A̲R̲N̲I̲N̲G̲S̲
Same as Error-Messages.
2.8 A̲P̲P̲E̲N̲D̲I̲X̲
An appendix could contain an overview of all the screen
formats. This could be valuable for a quick use of
the guide for the more experienced user.
3. S̲U̲P̲E̲R̲V̲I̲S̲O̲R̲ ̲A̲N̲D̲ ̲A̲S̲S̲I̲S̲T̲A̲N̲T̲S̲ ̲G̲U̲I̲D̲E̲
3.1 G̲E̲N̲E̲R̲A̲L̲
a) The same approach as for the Users Guide should
be used.
b) The tasks assigned to the Supervisor and the Assistants
should be clearly defined avoiding any confusion
as to who is doing what and how.
c) Possible malfunctions and mistakes should be listed,
together with the appropriate action to be taken.
4 O̲P̲E̲R̲A̲T̲O̲R̲S̲ ̲G̲U̲I̲D̲E̲
4.1 G̲E̲N̲E̲R̲A̲L̲
a) The same approach as for the Users Guide should
be used.
b) In addition, Cold-Start and Warm-Start procedures
should be explained step-by-step.
c) System parameter definition and changes should
be clearly defined in step-by-step procedures with
appropriate example.
d) Off and On-Line tests should be listed and operation
procedure for each of them should be defined in
detail and step-by-step. Appropriate and covering
examples how to run the tests should be attached.
Result analysis of each of the tests should be
given, together with the applicable action to take
in case of malfunctions.
5 C̲S̲S̲I̲ ̲G̲U̲I̲D̲E̲
The approach as mentioned for the User, Supervisor
and Assistant Guide should be used.
