Company:

Phylosoftware

Documentation of automated systems according to GOST 34

• Dates: 30.09.10.
• Duration: 2 days.
• Max. number of group: The 20th persons.

I. An automated system and documentation on it

1. An automated system in terms of GOST 34

Idea of AS. GOST 34.003-90: formal determination of AS and his sense. Classification of AS.

Idea of parts of AS. Personnel, programs, equipment; interrelation between components. Subsystems. Types of providing and AS components.

Idea of the automated activity. Purposes and EXPERT functions. Tasks. Information model, and/or business processes.

Idea of an order of creation of AS. GOST 34.601-90: stages of creation of AS, high-level overview.

2. Documentation on AS in terms of GOST 34

Formal requirements to documentation. System documentation and documentation on components. GOST 34.201-89: types and document types. Interrelation of stages of creation of AS with documents. RD 50-34.698-90: requirements to contents of documents. GOST 2.105-95: requirements to document creation. Assignment to documents of ciphers and codes. Complexes of the ESPD and ESKD standards.

Principles of formation of a documentation kit. Technical documentation — the tool, but not a ritual. Motives of inclusion of the document in a set: for the benefit of the customer and/or for the benefit of the contractor, typical requirements to which satisfaction serves documents. Justification of structure of a documentation kit before the customer.

Summary cards. AS components and scopes of standards. Stages of creation of AS, documents and requirements to them.

3. Documentation of development of AS

Preproject stages. Formation of requirements to AS. Concept of AS. GOST 7.32-2001: design of results of inspection and concept. The Technical Specifications (TS) on AS. A key role of terms of reference during creation of AS. GOST 34.602-89: requirements to contents of terms of reference. Recommendations about style of statement of terms of reference.

Outline sketch, engineering design. Overview of documents of the outline sketch and engineering design. Explanatory note. The description of the automated functions. Description of project procedure. Description of an organization structure. Description of KTS.

Work documentation. Overview of documents of a stage "work documentation". Document "Program and Test Procedure" and its interrelations with terms of reference. Design estimates. Idea of executive documentation.

Summary cards. Interrelations between documents of different stages. "Obligatory" and "optional" documents.

4. Operational documentation of AS

Operational Documentation (OD) and its features. ED as part of AS. Formal requirements to ED.

Documentation of operational personnel. Form. Specification. General description of a system. Operating instruction KTS. Guide of the system programmer.

Documentation of users. Operator guide. User guide. Technology instruction. Process descriptions. Delivery of ED of audience. Hard copies and electronic documents. Formats of electronic documentation.

Design of ED. Requirements to completeness, profiling, style of statement and to others it is difficult for the ED formalizable properties. Analysis of audiences and formation of a set of ED. The ISO/IEC GOST P standards on documentation of the user.

II. Organization of documentation of AS

5. Development of technical documentation in the project

Formalization of requirements to documentation. What should be specified in the agreement creation of AS. Recommendations about drawing up the section of "The requirement to documentation" in technical specifications on AS: minimum structure of requirements to technical documentation.

The organization of documentation in a command. Distribution of obligations for preparation of documentation of different type between project participants. Cycle of preparation of the document. Work planning on documentation. Assessment of terms and labor input. The typical risks connected with preparation of documentation. The principles of exchange of documents between the Contractor and the Customer. Features of development of operational documentation. Unforeseen state standard specifications, but important documents. Project charter, book of the project, project report.

6. Technology of development of documentation

Stock of developers of documentation. Templates, pustografki, examples. Library of normative and technical documents. Standard instructions for project participants.

Interrelations between documents and their use. The sections of documents consisting in cause and effect, logical and textual interrelations. Formation drawing up sections of documents of the subsequent stages on the basis of sections of documents of the previous stages. Microsoft Word, friend and enemy of the developer of documentation. Technical risks during the work with the documents Microsoft Word. Technical requirements to documents in the Microsoft Word format.

Possible alternatives of Microsoft Word. Idea of the principle of a uniform source. Technology platforms and work benches: AuthorIT, DocBook/XML, DITA, Rational SoDA.

7. Typical conflicts and methods of their overcoming

The conflicts arising between the contractor and customer are considered it is especially frequent. Their reasons and methods of overcoming are discussed.

A) "Let's begin to program, and we will make documentation later!"

B) "There passed two months, and we have instead of a system one documentation!"

C) "Your documentation is no good!"

D) "You broke the tough term and therefore …"

Case 1: "… here to you new, even more tough!"

Case 2: "… give at least work we will make normally!"

E) "It was not urgent, became suddenly urgent".

F) "Here Ivan Ivanych looked at your documentation …"

Case 1: there passed accidentally by one large specialist.

Case 2: The VIP in an ambush.

Case 3: incomplete authority delegation.

G) "Every day something brand new".

H) Nonconstructive reproaches.

"We for you wrote this documentation!"

"During this time we would make everything by own efforts!"

***