http://comet.de/mobile

Writing Manuals - Basic Principles

2 days

Creating effective documentation

It is always challenging to present information clearly and simply in user manuals. Contents need to be consistent and free of redundancies to achieve this goal.

Since manuals are frequently modified and are often created by numerous authors, it is extremely important to establish a solid basis at the beginning in order to create documentation that is clearly structured and easy to maintain. This course shows you how to create easy-to-read manuals and even make your work easier simply by following some important basic guidelines.

Course Objectives

You will get to know the most important rules about writing manuals. Practical examples will show you how to implement the rules.

Audience

Persons who want to start working in the field of documentation or would like to refresh their knowledge of documentation.

Prerequisites

A basic understanding of English is recommended for editing some examples in English. We also recommend basic skills in Word or FrameMaker. Depending on your requirements, we recommend our course „User Documentation for Software“.

Prices

on request

Dates

on request

Please contact our training center for further information.

 

Contents

  • Why are manuals not read?
  • Why are manuals not understood?
  • Objectives of editing
  • Applying the following principles:
    - Clarity
    - Task orientation
    - Logical consistency
    - Accuracy
    - Consistency
    - Organization
    - Comprehensibility
    - Completeness
    - Guidance

Continuation Courses

 

     
 

Home | Editorial Notes

Comet® and the Comet logo are registered trademarks
of the companies Comet Computer GmbH and Comet Communication GmbH.