User Manual (GB8567-88)
1 Introduction
1.1 Writing
Description Writing the purpose of this user manual, pointing out the expected readers.
1.2 background
Description:
a. The name of the software system described in this user manual;
b. This software project is tasted, developers, users (or first batch users) and the calculation center to install this software.
1.3 definition
List the definitions of the specimen used in this document and the original phrase of the foreign letter group word.
1.4 Reference
List useful references, such as:
a. Approval plan task book or contract, the approval of the superior authority;
b. Other issued documents belonging to this project;
c. Files, information, information, including the software development standards you want. List the title, file number, publishing date, and publishing unit of these files, indicating that the source of these files can be obtained.
2 use
2.1 function
In conjunction with the development of this software, the software has various functions and their limit range.
2.2 performance
2.2.1 precision
Type item by item Description The accuracy requirements of the input data and the accuracy of the data of this software output data include the accuracy requirements in the transmission.
2.2.2 Time Features
Quantitatively explains the time characteristics of the software, such as response time, update processing time, data transfer, conversion time, calculation time, and the like.
2.2.3 Flexibility
Describe the flexibility of this software, that is, when the user needs (such as the requirements of the operation, operating environment, resulting accuracy, time characteristics, etc.), the software adaptation capability.
2.3 Security confidentiality
Describe the software in security, confidential design considerations and the actual capacity.
3 operating environment
3.1 hard equipment
List the minimum configuration of hard devices required to run this software, such as:
a. Model, memory capacity of the processor
b. The required outer memory, media, record format, model of the device, and the number of benchs, online / offline;
c. I / O equipment (online / offline?);
d. Data transmission device and the model number of the conversion device.
3.2 Support Software
Explain that the support software required to run this software, such as:
a. The name, version number of the operating system;
b. Compile / assembly system name and version number;
C. The name and version number of the database management system;
d. Other support software.
3.3 data structure
Lists the database or data volume required to support the run of the software.
4 use process
In this chapter, the functionality of the software function is first described in this chapter, and the relationship between the software function is the same as the system, and the output receiving mechanism is used.
4.1 Installation and Initialization
Step by step, the installation and initialization process required to use this software, including the storage form of the program, all operation commands in the installation and initialization process, the system responds to these commands. Test instances that characterize the installation work. If there is, you should also explain the dedicated software you need during the installation process.
4.2 input
Prepare the preparation requirements for input data and parameters.
4.2.1 Realistic background for entering data
Note the real background of input data, mainly
a. situation - such as personnel change, stock out of stock;
b. The frequency of the situation is, for example, a function of periodic, random, an operational state;
c. Sources -,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
d. Enter Media --- For example, keyboard, perforated card, tape;
e. Restrictions - for security, confidentiality to access these input data;
f. Quality Management - For example, the rationality of the input data and the measures that should be taken when entering data have an error, such as a record of the error condition, etc .; g. Gaffene, for example, how to determine whether the input data is reserved or abandoned, To assign other recipients, etc..
4.2.2 Input Format
Description Format requirements for initial input data and parameters, including grammar rules and related conventions, such as:
a. Length - a number of characters / rows, characters / items;
b. Format benchmark -, for example, the edge of the left;
c. Number, such as tag or identifier;
d. sequence - such as the order and position of each data item;
e. Bad points -, for example, the space, slash, asterisk, character group, etc. used to represent the start or end of the line, data sets, etc.
f. Vocabulary - give a list of characters that allow for use, forbidden to use the list of characters combinations;
g. omissions and repetition - given a means of representation to indicate losing elements can be omitted or repeated;
h. Control - gives the control information to indicate the start or end of the input.
4.2.3 Input Examples
Provide samples for each complete input, including:
a. Control or header - for example, information to indicate the types and types of the input, the identifier input date, the initial starting point, and the provisions of the encoded used;
b. Main body - input data, including input representation of data volume;
C. The tail - used to indicate the control information of the input, the total number of characters, etc.
d. Omitted - indicates which input data is omitted;
e. Repeat - indicates which input data is repeated.
4.3 Output to make a description of each output
4.3.1 Realistic Background of Output Data
Describe the real background of the output data, mainly:
a. Use - Who is it given to these output data?
b. Use frequency - such as weekly, periodic or preparation;
C. Media - print, CRI display, tape, card, disk,
d. Quality Management -, for example, a rule of error correction, error correction;
e. Growth - For example, how to determine whether the output data is reserved or disposed, whether it is assigned to other recipients.
4.3.2 Output Format
The interpretation of each type of output information is given to:
a. The header - identifier, output date and output number of output data;
b. Main body - the main body of output information, including column headings;
C. Tail - including accumulated total, end tags.
4.3.3 Output Example
Provide an example for each output type. Each of the examples, description:
a. Definition - The meaning and use of each output information;
b. Source - is extracted from a specific input, removed from the database text, or from the software's calculation process;
C. Features - output value domain, measurement unit, where to save, etc.
4.4 Wen Volume Inquiry
This article is written for software with query capabilities, including: Initialization, preparation, and processing related to database queries, explaining the ability, way of the query, the command, and the required control regulations.
4.5 Error handling and recovery
List the error coding or condition generated by the software and the modification of the user should be corrected. It is pointed out that the user must follow the process of processing in order to ensure reacture and recovery.
4.6 terminal operation
