top - download
⟦14c2707c0⟧ Wang Wps File
Length: 4001 (0xfa1)
Types: Wang Wps File
Notes: CPS/STD/003
Names: »4872A «
Derivation
└─⟦e27572af5⟧ Bits:30006187 8" Wang WCS floppy, CR 0422A
└─ ⟦this⟧ »4872A «
WangText
…02…CPS/STD/003
…02…LRS/840502…02……02…#
STANDARD FOR STRUCTURE OF USER MANUAL
…02……02…CAMPS
T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲
1 GENERAL ........................................
4
1.1 PURPOSE AND SCOPE ..........................
4
1.2 APPLICABLE DOCUMENTS .......................
4
1.3 ABBREVIATIONS ..............................
4
2 CONTENTS OF USM ................................
5
2.1 GENERAL ....................................
5
2.2 TABLE OF CONTENTS ..........................
5
3 DESCRIPTION OF CONTENTS OF USM'S CHAPTERS ......
6
3.1 GENERAL (CHAPTER 1 OF USM) .................
6
3.2 ENVIRONMENT (CHAPTER 2 OF USM) .............
6
3.3 FUNCTIONAL DESCRIPTION(CHAPTER 3 OF THE USM)
6
3.4 DETAILED DESCRIPTION OF ACTIVATION/FUNCTIONS
(CHAPTER 4 OF USM) .........................
6
3.5 ERROR REPORTS (CHAPTER 5 OF USM) ...........
6
1̲ ̲ ̲G̲E̲N̲E̲R̲A̲L̲
1.1 P̲U̲R̲P̲O̲S̲E̲ ̲A̲N̲D̲ ̲S̲C̲O̲P̲E̲
The purpose of this standard document is to define
the contents of a USER MANUAL. Thereby all USER MANUALS
written for the CAMPS-project will be homogeneous in
structure and ease accessibility and comprehension
for the user.
1.2 A̲P̲P̲L̲I̲C̲A̲B̲L̲E̲ ̲D̲O̲C̲U̲M̲E̲N̲T̲S̲
NOT APPLICABLE
1.3 A̲B̲B̲R̲E̲V̲I̲A̲T̲I̲O̲N̲S̲
LP - LINE PRINTER
USM - USER MANUAL
VDU - VISUAL DISPLAY UNIT
2̲ ̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲ ̲O̲F̲ ̲U̲S̲M̲
2.1 G̲E̲N̲E̲R̲A̲L̲
The person who is preparing an USM shall include chapters
and paras as listed below. The chapters and paras shall
be ordered in the described sequence (if there is no
information pertinent to a chapter or para the following
text shall appear below the chapter or para heading:
NOT APPLICABLE, or if the information is stated in
another chapter/para in the USM reference shall be
given to this. Subparas can be defined to give a better
overview. They shall be included in TABLE OF CONTENTS.
2.2 T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲
1 General
1.1 Purpose and scope
1.2 Applicable documents
1.3 Abbreviations
2 Environment
2.1 Equipment
2.2 S/W
2.3 Interfaces
3 Functional description
3.1 Overview
3.2 Syntax
3.3 Semantic
4. Detailed description of activation/functions
4.1 Program activation
4.2 Input/Output
5 Error reports
3̲ ̲ ̲D̲E̲S̲C̲R̲I̲P̲T̲I̲O̲N̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲ ̲O̲F̲ ̲U̲S̲M̲'̲S̲ ̲C̲H̲A̲P̲T̲E̲R̲S̲
3.1 G̲E̲N̲E̲R̲A̲L̲ ̲(̲C̲H̲A̲P̲T̲E̲R̲ ̲1̲ ̲o̲f̲ ̲U̲S̲M̲)̲
The first chapter of USM shall deliniate the purpose
and scope of the USM. Furthermore specification of
abbreviations used and reference of documents which
are applicable.
3.2 E̲N̲V̲I̲R̲O̲N̲M̲E̲N̲T̲ ̲(̲C̲H̲A̲P̲T̲E̲R̲ ̲2̲ ̲O̲F̲ ̲U̲S̲M̲)̲
The second chapter shall give information of environment
i.e. applicable equipment, S/W and interfaces. A diagram
can be used to ease the understanding.
3.3 F̲U̲N̲C̲T̲I̲O̲N̲A̲L̲ ̲D̲E̲S̲C̲R̲I̲P̲T̲I̲O̲N̲ ̲(̲C̲H̲A̲P̲T̲E̲R̲ ̲3̲ ̲O̲F̲ ̲T̲H̲E̲ ̲U̲S̲M̲)̲
The third chapter of USM shall give a short description
of the functional capabilities to give the user a brief
overview of the item in question. A flow can be used
to ease the understanding. The syntax and semantics
used shall also be stated.
3.4 D̲E̲T̲A̲I̲L̲E̲D̲ ̲D̲E̲S̲C̲R̲I̲P̲T̲I̲O̲N̲ ̲O̲F̲ ̲A̲C̲T̲I̲V̲A̲T̲I̲O̲N̲/̲F̲U̲N̲C̲T̲I̲O̲N̲S̲ ̲(̲C̲H̲A̲P̲T̲E̲R̲
̲4̲ ̲O̲F̲ ̲U̲S̲M̲)̲
The fourth chapter shall give detailed description
of activation i.e. loading of a program. Furthermore
what is input e.g. commands, parameters and what is
output on e.g. VDU, LP.
3.5 E̲R̲R̲O̲R̲ ̲R̲E̲P̲O̲R̲T̲S̲ ̲(̲C̲H̲A̲P̲T̲E̲R̲ ̲5̲ ̲O̲F̲ ̲U̲S̲M̲)̲
The fifth chapter shall give information of errors
which can occur during operation. If the error reports
are selfexplanatory a list is set up. If error codes
(numbers) are used a table of error codes including
explanation and which action to take shall be defined.
