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.
16 hours
Online
English
REQ-028
Effective Development of User Documentation
Sign Up
Duration
16 hours
Location
Online
Language
English
Code
REQ-028
Schedule and prices
€ 290
Training for 7-8 or more people? Customize trainings for your specific needs
Effective Development of User Documentation
Sign Up
Duration
16 hours
Location
Online
Language
English
Code
REQ-028
Schedule and prices
€ 290
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.
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

  • Quality of documentation

    • Technical writer’s tasks
    • Requirements for documentation
  • Stages of documentation creation and types of work

    • Creating documentation as a part of SW development project
    • Stages of documentation development
    • Assignment for documentation development
  • Types and structure of documents

    • Different types of technical documents
    • Document form and structure, types of information
    • Use cases
    • Developing the document functional part
    • Developing the reference and descriptive parts of documents
    • Structure-driven sections
  • Text elaboration and arrangement

    • Basic principles of information presentation
    • Examples of poor quality texts
    • Rules for text formatting, style discipline
    • Documents verification
  • Technical writers’ tools and resources

    • Recommendations for using MS Word
    • Additional web resources and useful tools
  • Show Entire Program
Schedule and prices
View:
Register for the next course
Registering in advance ensures you have priority. We’ll notify you when we schedule the next course on this topic
+
Courses you may be interested in
UML Modeling with Sparx Systems Enterprise Architect
Acquire the basic skills for working with the Enterprise Architect CASE-tool, released by Sparx Systems. We focus on functions for UML model construction and the most commonly used types of UML diagrams
Business process modeling with BPMN 2.x
Learn the application rules for the graphic elements of the language, study the types of BPMN diagrams and discover the possibilities of automatic execution of the constructed models.
ECBA Exam Preparation - IIBA
This training is developed to help you prepare for the ECBA certification exam.
View Catalog
Your benefits
Expertise
Our trainers are industry experts, involved in software development project
Live training
Facilitated online so that you can interact with the trainer and other participants
Practice
A focus on helping you practice your new skills
Still have questions?
Connect with us
Thank you.
Your request has been received.
Thank you!
The form has been submitted successfully.