Effective Development of User Documentation

Effective Development of User Documentation

We cover the process of creating user documentation for software products, such as document structure, the rules for outlining and formatting, and documentation quality criteria.

Duration
16 hours
Course type
Online
Language
English
Article
REQ-028
Duration
16 hours
Location
Online
Language
English
Code
REQ-028
Training for 7-8 or more people? Customize trainings for your specific needs
Effective Development of User Documentation
Duration
16 hours
Location
Online
Language
English
Code
REQ-028
€ 450 *
Training for 7-8 or more people? Customize trainings for your specific needs

Description

This training covers the entire unified process of creating end user documentation – from defining its structure through reviewing and publication.


A lot of attention is paid to the various aspects of correcting, wording and formatting the text. You’ll analyze and correct numerous examples of clumsy phrasings from different sources.


Writing technical documents (such as specifications, requirements, etc.) is not an inherent task for technical writers, yet they should be able to understand such documents and retrieve necessary information from them for writing end user documentation. Therefore, this course is also focused on one form of requirements description – use cases, which can be transformed into step-by-step instructions for users.

certificate
After completing the course, a certificate
is issued on the Luxoft Training form

Objectives

  • Learn how to define requirements for documentations and apply them
  • How to correctly present information
  • How to apply the rules for arranging and formatting documentation
  • Identify and correct typical errors in technical documentation
  • Use advanced tools for text formatting (MS Word)

Target Audience

  • This course is designed for technical writers, including beginners

Prerequisites

  • General knowledge of software development processes
  • Experience with using word processors and other text processing software

Roadmap

Topic

Theory, min

Practice, min

1. Quality of documentation

· Technical writer’s tasks

60

20

· Requirements for documentation

50

20

2. Stages of documentation creation and types of work

· Creating documentation as a part of SW development project

30

20

· Stages of documentation development

30

· Assignment for documentation development

15

3. Types and structure of documents

· Different types of technical documents

30

· Document form and structure, types of information

40

· Use cases

70

40

· Developing the document functional part

15

· Developing the reference and descriptive parts of documents

15

· Structure-driven sections

15

4. Text elaboration and arrangement

· Basic principles of information presentation

120

30

· Examples of poor-quality texts

40

· Document layout

40

· Differences between Russian and English language documents

40

· Descriptions for specific elements

40

· Ensuring document quality

40

30

5. Technical writers’ tools and resources

· Recommendations for using MS Word

40

40

· Additional web resources and useful tools

30

720 (75%)

240 (25%)
Still have questions?
Connect with us