The Unified System of Documentation of Software Products - ESPD - belongs to GOST class 19 and is divided into 10 groups:
1. Fundamental Standards.
2. Rules for executing development documentation.
3. Rules for executing manufacturing documentation.
4. Rules for the implementation of support documentation.
5. Rules for the implementation of operational documentation.
6. Rules for circulation of software documentation.
Standard number 0 contains general provisions, standards 7 and 8 are reserved, and number 9 includes other standards not included in the first 6.
These are brief descriptions of GOSTs of class 19; for more detailed information, please refer to the reference books.
List of documentation declared by GOST 19.105-78:
1. Documents containing information necessary for the development of a software product and its manufacture.
1.1. Specification – the composition of the program and its documentation.
1.2. List of original holders - a list of enterprises where original program documentation is stored.
1.3. Program text – record the program text with the necessary comments.
1.4. Program description – information about the logical and functional structure of the program.
1.5. Test program and methodology - requirements to be verified when testing the program, procedure and methods for their control.
1.6. Terms of reference – purpose and scope of application of the program, technical and special requirements, necessary stages and terms of development, types of tests.
2. Documents used when operating the software product.
List of operational documents – a list of operational documents for the program.
Form – main characteristics of the program, completeness, general information about the operation of the program.
Description of application - information about the purpose of the program, scope of application, class of tasks to be solved, restrictions on use, required configuration of hardware.
System Programmer's Guide - information for checking and ensuring functionality, setting up the program.
Programmer's Guide - information for operating the configured program.
Operator's manual - information to ensure the procedure for communication between the operator and the computer during program execution.
Language description – description of the syntax and semantics of the language used in the program.
Maintenance Manual - information for using test programs when servicing technical equipment.
Other GOSTs class 19:
Technical documentation system for automated control systems |
GOST 24.207-80 |
REQUIREMENTS FOR THE CONTENT OF SOFTWARE DOCUMENTS |
|
System of technical documentation for computer control systems. Requirements for contents of documents on software |
By Decree of the USSR State Committee on Standards dated May 14, 1980 No. 2101, the introduction date was established
from 01/01/1981
This standard applies to technical documentation for automated control systems (ACS) of all types, developed for all levels of management (except for national ones), and establishes requirements for the content of documents included in accordance with GOST 24.101-80 as part of the software documentation in ACS projects.
1.1. The software documentation is intended to:
1.2. When developing documents for parts of an automated control system, the content of sections of each document is limited to the framework of the corresponding part.
1.3. Depending on the purpose and specific features of the created automated control systems, it is allowed to include additional sections in documents, the content requirements of which are not established by this standard. The absence of design solutions for a section of the document is recorded in the appropriate section with the necessary explanations.
1.4. Requirements for the content of documents “Technical Specifications”, “Explanatory Note”, “Description of Application”, “Specification”, “Operator’s Manual”, “Program Text”, “Form”, “Test Procedure and Methodology” are established by GOST 19.201-78, GOST 19.404-79, GOST 19.502-78, GOST 19.202-78, GOST 19.505-79, GOST 19.401-78, GOST 19.501-78 and GOST 19.301-79.
(Changed edition, Amendment No. 1).
2.1.1. The document must contain an introductory part and sections:
2.1.2. The introductory part should contain basic information about the technical, information and other types of automated control system support necessary for software development, or a link to the relevant documents of the automated control system project.
2.1.3. The “Software Structure” section should contain a list of software parts, indicating their relationships and the rationale for identifying each of them.
2.1.4. The section “Main functions of software parts” should contain subsections in which, for each part of the software, the purpose and description of the main functions are given.
(Changed edition, Amendment No. 1).
2.1.5. The section “Methods and tools for software development” should contain a list of programming methods and tools for developing automated control system software, indicating parts of the software in the development of which appropriate methods and tools should be used.
2.1.6. The "Operating System" section should contain:
2.1.7. The “Tools that extend the capabilities of the operating system” section should contain subsections in which for each tool used that extends the capabilities of the operating system, you should indicate:
2.2.2. For a program (set of programs) obtained through the use of previously developed software, the “Program Description” document should be supplemented with the “Software Setup” section.
2.2.3. The “Software Configuration” section should contain:
2.3.1. The document on the composition of the sections and their content must comply with GOST 19.504-79 and, in addition, include the section “Information on the form of presentation of the program (set of programs).”
2.3.2. The section “Information about the form of presentation of the program (set of programs)” must contain information about the medium on which the program is recorded, about the content and coding system of information recorded on the medium, as well as information necessary for reading information from the medium.
2.3.3. For a program (set of programs) that can be customized to the conditions of a specific application, the “Programmer’s Guide” document includes sections:
2.3.4. It is allowed for a program (set of programs) that can be customized to the conditions of a specific application, instead of the sections listed in clause 2.3.3, to develop a separate document “System Programmer’s Guide” that meets the requirements of GOST 19.503-79.
2.4.1. The document must contain sections:
2.4.2. The “Purpose” section should contain a list of parameters and a brief description of the function that is implemented by the program (set of programs) that is tested by the test example.
2.4.3. The “Initial data” section must contain a description of the initial data for testing the program (set of programs) with the presentation of the initial data. It is allowed to present the source data in the form of a printout from the ADCP.
2.4.4. The “Calculation Results” section should contain the results of processing the initial data by a program (set of programs), allowing one to evaluate the correct execution of the functions being tested and the value of the parameters being tested. It is allowed to present the calculation results in the form of a printout from the ADCP.
2.4.5. The section “Checking the program (set of programs)” should contain:
Unified system of program documentation |
GOST 19.101-77(ST SEV 1626-79) |
TYPES OF PROGRAMS AND PROGRAM DOCUMENTS |
|
United system for program documentation. Types of programs and program documents |
Date of introduction from 01.01.80
This standard establishes the types of programs and program documents for computers, complexes and systems, regardless of their purpose and scope.
The standard fully complies with ST SEV 1626-79.
1.1. The program (according to GOST 19781-90) can be identified and used independently and (or) as part of other programs.
1.2. Programs are divided into types shown in table. 1
Table 1
1.3. The documentation developed for the program can be used for the implementation and transfer of the program on storage media, as well as for the manufacture of a software product.
1.2,1.3.
2.1. Software documents include documents containing information necessary for the development, production, maintenance and operation of programs.
2.2. Types of program documents and their contents are given in table. 2.
table 2
Type of program document | Contents of the policy document |
---|---|
Specification | Composition of the program and its documentation |
List of enterprises that store original program documents | |
Program text | Recording the program with the necessary comments |
Program description | Information about the logical structure and operation of the program |
Requirements to be verified when testing the program, as well as the procedure and methods for their control | |
Technical task | Purpose and scope of the program, technical, feasibility and special requirements for the program, necessary stages and terms of development, types of tests |
Explanatory note | Algorithm diagram, general description of the algorithm and (or) operation of the program, as well as justification of the adopted technical and technical-economic decisions |
Operational documents | Information to ensure the functioning and operation of the program |
(Changed edition, Amendment No. 1).
2.3. Types of operational documents and their contents are given in Table 3.
Table 3
Type of operational document | Contents of the operational document |
---|---|
List of operational documents for the program | |
Form | Main characteristics of the program, completeness and information about the operation of the program |
Description of application | Information about the purpose of the program, scope of application, methods used, class of problems to be solved, restrictions for use, minimum configuration of hardware |
Information for checking, ensuring the functioning and customizing the program for the conditions of a specific application | |
Programmer's Guide | Information for using the program |
Operator's manual | Information to ensure the procedure for communication between the operator and the computer system during program execution |
Language description | Description of the syntax and semantics of the language |
Information for the use of test and diagnostic programs when servicing technical equipment |
(Changed edition, Amendment No. 1).
2.4. Depending on the method of implementation and the nature of application, program documents are divided into original, duplicate and copy (GOST 2.102-68), intended for the development, maintenance and operation of the program.
2.5. The types of program documents developed at different stages and their codes are given in the click table. 4.
Table 4
Document type code | Document type | Development stages | |||
---|---|---|---|---|---|
Preliminary design | Technical project | Working draft | |||
component | complex | ||||
- | Specification | - | - | ||
05 | List of original holders | - | - | - | |
12 | Program text | - | - | ||
13 | Program description | - | - | ||
20 | List of operational documents | - | - | ||
30 | Form | - | - | ||
31 | Description of application | - | - | ||
32 | System Programmer's Guide | - | - | ||
33 | Programmer's Guide | - | - | ||
34 | Operator's manual | - | - | ||
35 | Language description | - | - | ||
46 | Maintenance Manual | - | - | ||
51 | Test program and methodology | - | - | ||
81 | Explanatory note | - | - | ||
90-99 | Other documents |
Legend:
- the document is mandatory;
- the document is mandatory for components that have independent use;
- the need to draw up a document is determined at the stage of development and approval of the technical specifications;
- - the document is not drawn up.
2.2-2.5. (Changed edition, Amendment No. 1).
2.6. It is allowed to combine certain types of operational documents (with the exception of the list of operational documents and the form). The need to combine these documents is indicated in the technical specifications. The merged document is assigned the name and designation of one of the merged documents.
Merged documents must specify the information that must be included in each document being merged.
2.7. At the stage of development and approval of the technical specifications, the need to draw up technical specifications containing requirements for the production, control and acceptance of the program is determined.
Technical specifications are developed at the “Detailed Design” stage.
2.8. The need to draw up technical specifications for components not intended for independent use, and complexes included in other complexes, is determined by agreement with the customer.
(Introduced additionally, Amendment No. 1).
Reissue (November 1987) with Change No. 1, approved in June 1981 (IUS 9-81)
Name:
Unified system of program documentation.
Valid
Date of introduction:
Cancellation date:
Replaced by:
GOST 19.101-77
INTERSTATE STANDARD
UNIFIED SOFTWARE DOCUMENTATION SYSTEM
Official publication
Standardinform
UDC 002:651.7/.78:006.354
Group T55
Unified system for program documentation.
Types of programs and program documents
By Decree of the State Committee of Standards of the Council of Ministers of the USSR dated May 20, 1977 No. 1268, the introduction date was set
This standard establishes the types of programs and program documents for computers, complexes and systems, regardless of their purpose and scope.
The standard fully complies with ST SEV 1626-79.
(Changed edition, Amendment No. 1).
1.1. The program (according to GOST 19781-90) can be identified and used independently and (or) as part of other programs.
1.2. Programs are divided into types shown in table. 1.
1.3. The documentation developed for the program can be used for the implementation and transfer of the program on storage media, as well as for the manufacture of a software product.
2.1. Software documents include documents containing information necessary for the development, production, maintenance and operation of programs.
2.2. Types of program documents and their contents are given in table. 2.
Official publication ★
Reproduction is prohibited
) Standards Publishing House, 1977 © STANDARDINFORM, 2010
Edition (January 2010) with Amendment No. 1, approved in June 1981 (IUS 9-81).
table 2
Type of program document | |
Specification |
Composition of the program and its documentation |
List of holders of authentic |
List of enterprises that store original programs - |
new documents |
|
Program text |
Recording the program with the necessary comments |
Program description |
Information about the logical structure and operation of the program |
Test program and methodology |
Requirements to be verified when testing the program, as well as |
procedure and methods of their control |
|
Technical task |
Purpose and scope of the program, technical, feasibility and special requirements for the program, necessary stages and terms of development, types of tests |
Explanatory note |
Algorithm diagram, general description of the algorithm and (or) operation of the program, as well as justification of the adopted technical and technical-economic decisions |
Operational documents |
Information to ensure the functioning and operation of the program |
2.3. Types of operational documents and their contents are given in table. 3.
Table 3
operational document
List of operational documents Form
Description of application
Programmer's Guide Operator's Guide
Language Description Service Manual
List of operational documents for the program
Main characteristics of the program, completeness and information about the operation of the program
Information about the purpose of the program, scope of application, methods used, class of problems to be solved, restrictions for use, minimum configuration of hardware
Information for checking, ensuring the functioning and customizing the program for the conditions of a specific application
Information for using the program
Information to ensure the procedure for communication between the operator and the computer system during program execution
Description of the syntax and semantics of the language
Information for the use of test and diagnostic programs when servicing technical equipment
2.4. Depending on the method of implementation and the nature of application, program documents are divided into original, duplicate and copy (GOST 2.102-68), intended for the development, maintenance and operation of the program.
2.5. The types of program documents developed at different stages and their codes are given in Table. 4.
Table 4
Document type code |
Document type |
Development stages |
|||
Sketchy |
Technical |
Working draft |
|||
component |
complex |
||||
Specification | |||||
List of holders of authentic | |||||
Program text | |||||
Program description | |||||
Operating sheet | |||||
documents | |||||
Form |
Continuation of table 4
Document type code |
Development stages | ||||
Document type |
Sketchy |
Technical |
Working draft |
||
component |
complex |
||||
Description of application | |||||
System Programmer's Guide | |||||
Programmer's Guide | |||||
Operator's manual | |||||
Language description | |||||
Maintenance Manual | |||||
Test program and methodology | |||||
Explanatory note | |||||
Other documents |
Legend:
The document is mandatory;
C - a mandatory document for components that have independent use;
O - the need to draw up a document is determined at the stage of development and approval of the technical specifications;
The document is not drawn up.
2.6. It is allowed to combine certain types of operational documents (with the exception of the list of operational documents and the form). The need to combine these documents is indicated in the technical specifications. The merged document is assigned the name and designation of one of the merged documents.
Merged documents must specify the information that must be included in each document being merged.
2.7. At the stage of development and approval of the technical specifications, the need to draw up technical specifications containing requirements for the production, control and acceptance of the program is determined.
Technical specifications are developed at the “Detailed Design” stage.
2.8. The need to draw up technical specifications for components not intended for independent use, and complexes included in other complexes, is determined by agreement with the customer.
(Introduced additionally, Amendment No. 1).
Unified system of program documentation |
GOST 19.101-77(ST SEV 1626-79) |
TYPES OF PROGRAMS AND PROGRAM DOCUMENTS |
|
United system for program documentation. |
By Resolution of the State Committee of Standards of the Council of Ministers of the USSR dated May 20, 1977 No. 1268, the introduction date was established
from 01/01/1980
This standard establishes the types of programs and program documents for computers, complexes and systems, regardless of their purpose and scope.
The standard fully complies with ST SEV 1626-79.
1.1. The program (according to GOST 19781-90) can be identified and used independently and (or) as part of other programs.
1.2. Programs are divided into types shown in table. 1
Table 1
1.3. The documentation developed for the program can be used for the implementation and transfer of the program on storage media, as well as for the manufacture of a software product.
1.2,1.3.
2.1. Software documents include documents containing information necessary for the development, production, maintenance and operation of programs.
2.2. Types of program documents and their contents are given in table. 2.
table 2
Type of program document | Contents of the policy document |
---|---|
Specification | Composition of the program and its documentation |
List of enterprises that store original program documents | |
Program text | Recording the program with the necessary comments |
Program description | Information about the logical structure and operation of the program |
Requirements to be verified when testing the program, as well as the procedure and methods for their control | |
Technical task | Purpose and scope of the program, technical, feasibility and special requirements for the program, necessary stages and terms of development, types of tests |
Explanatory note | Algorithm diagram, general description of the algorithm and (or) operation of the program, as well as justification of the adopted technical and technical-economic decisions |
Operational documents | Information to ensure the functioning and operation of the program |
(Changed edition, Amendment No. 1).
2.3. Types of operational documents and their contents are given in Table 3.
Table 3
Type of operational document | Contents of the operational document |
---|---|
List of operational documents for the program | |
Form | Main characteristics of the program, completeness and information about the operation of the program |
Description of application | Information about the purpose of the program, scope of application, methods used, class of problems to be solved, restrictions for use, minimum configuration of hardware |
Information for checking, ensuring the functioning and customizing the program for the conditions of a specific application | |
Programmer's Guide | Information for using the program |
Operator's manual | Information to ensure the procedure for communication between the operator and the computer system during program execution |
Language description | Description of the syntax and semantics of the language |
Information for the use of test and diagnostic programs when servicing technical equipment |
(Changed edition, Amendment No. 1).
2.4. Depending on the method of implementation and the nature of application, program documents are divided into original, duplicate and copy (GOST 2.102-68), intended for the development, maintenance and operation of the program.
2.5. The types of program documents developed at different stages and their codes are given in Table. 4.
Table 4
Document type code | Document type | Development stages | |||
---|---|---|---|---|---|
Preliminary design | Technical project | Working draft | |||
component | complex | ||||
- | Specification | - | - | ||
05 | List of original holders | - | - | - | |
12 | Program text | - | - | ||
13 | Program description | - | - | ||
20 | List of operational documents | - | - | ||
30 | Form | - | - | ||
31 | Description of application | - | - | ||
32 | System Programmer's Guide | - | - | ||
33 | Programmer's Guide | - | - | ||
34 | Operator's manual | - | - | ||
35 | Language description | - | - | ||
46 | Maintenance Manual | - | - | ||
51 | Test program and methodology | - | - | ||
81 | Explanatory note | - | - | ||
90-99 | Other documents |
Legend:
- the document is mandatory;
- the document is mandatory for components that have independent use;
- the need to draw up a document is determined at the stage of development and approval of the technical specifications;
- - the document is not drawn up.
2.2-2.5. (Changed edition, Amendment No. 1).
2.6. It is allowed to combine certain types of operational documents (with the exception of the list of operational documents and the form). The need to combine these documents is indicated in the technical specifications. The merged document is assigned the name and designation of one of the merged documents.
Merged documents must specify the information that must be included in each document being merged.
2.7. At the stage of development and approval of the technical specifications, the need to draw up technical specifications containing requirements for the production, control and acceptance of the program is determined.
Technical specifications are developed at the “Detailed Design” stage.
2.8. The need to draw up technical specifications for components not intended for independent use, and complexes included in other complexes, is determined by agreement with the customer.
(Introduced additionally, Amendment No. 1).
Reissue (November 1987) with Change No. 1, approved in June 1981 (IUS 9-81)