Effective development of user documentation - course RUB 22,900. from IBS Training Center, training 16 hours, Date November 29, 2023.
Miscellaneous / / December 02, 2023
Topics covered:
1. Quality of documentation.
Technical writer tasks (theory 60 minutes, practice 20 minutes);
Documentation requirements (theory 50 minutes, practice 20 minutes).
2. Stages of creating documentation and types of work.
Creation of documentation as part of a software development project (theory 30 minutes, practice 20 minutes);
Stages of documentation development (theory 30 minutes);
Documentation development task (theory 15 minutes).
3. Types, types and structure of documents.
Varieties of technical documents (theory 30 minutes);
Form and structure of the document, types of information (theory 40 minutes);
Use scenarios (theory 70 minutes, practice 40 minutes);
Development of the functional part of the document (theory 15 minutes);
Development of reference and descriptive parts of the document (theory 15 minutes);
Structure-based section (theory 15 minutes).
4. Development and organization of the text.
Basic principles of presentation (theory 120 minutes, practice 30 minutes);
Analysis of examples of low-quality texts (practice 40 minutes);
Preparation of documents (theory 40 minutes);
Differences between Russian and English documentation (theory 40 minutes);
Descriptions for specific elements (theory 40 minutes);
Ensuring the quality of documentation (theory 40 minutes, practice 30 minutes).
5. Tools and resources for the technical writer.
Recommendations for working with MS Word (theory 40 minutes, practice 40 minutes);
Additional online resources and useful tools (theory 30 minutes).