Technical Documentation Course

Course Description

This course emphasises the importance of documentation and the skills necessary to develop relevant, useful technical documents, from specifications to training material to policies. Digital formats and documentation projects are also discussed.

Prerequisites

Previous exposure to IT systems and wordprocessor programs. Familiarity with web development will be an advantage.

Intended Audience

Anybody who is required to develop technical documentation, including specifications, procedures and training material.

Contents

Overview

The importance of documentation. •  Why documentation fails. •  The responsibility for documentation. •  Documentation and industry standards. •  Approaches to documentation.

Types of technical documents

Project documentation. •  System documentation: user, functional and technical specifications. •  User documentation: manuals, instructions. •  Company documentation: policies, procedures.

The Documentation Process

Using the right person for documentation. •  Identify the purpose. •  Identify the audience. •  The best time to develop the documentation. •  Planning the documentation. •  Developing documentation prototypes. •  Managing the process.

Developing the Document

Components of a document: metadata, front matter, main matter, back matter. •  Gathering information. •  Creating an outline. •  The five factors in document organisation. •  Testing for usability.

Style and Design

Formatting issues. •  Grammar and writing style. •  Learning to write clearly. •  Tables and lists. •  Diagrams and flowcharts. •  The importance of standards and styles.

Digital Formats

Advantages and disadvantages of different types of digital formats: word-processor, web, database/XML. •  Formats to avoid. •  Engineering for reuse.

Documentation Project Management

The Information Plan. •  Planning the project. •  Tracking progress. •  Project standards. •  Review and control.

Documentation Management

Defining documentation management. •  Documentation management systems. •  Revision and version control.

Download the Technical Documentation course contents in PDF format for easy printing.

Need a course date? Please contact us at tel: (+27) 12 666 2020 or email us at info@incusdata.com for the next available course date.

Ready to book? Just fill out our course enrolment form and fax it to us at (+27) 12 666 2021 or email it to us at info@incusdata.com.

Home   |    Top of this page   |    Contact Us    Schedule   |    Course List   |    FAQ   |    Sitemap

Essential Skills for IT