Technical Documentation

Principles of Technical Documentation and Writing

Technical documentation and writing is a specialized field requiring knowledge and experience in it. The steps of technical are:

1. Preparation
2. Research
3. Organization
4. Writing the draft
5. Revision

Preparation

Preparation involves defining the purpose of the document, identifying the audience and determining the scope.

Research

The purpose of documentation is to convey information. In order to convey information, one must understand it thoroughly..

Organization

Here consider what you need to tell users, and how that information can best be conveyed.

Writing a Draft

A document has three parts:

Introduction

Body

Conclusion

Before starting writing, have an outline prepared. Expand the outline in small paragraphs and then complete the draft.

Revision

During revising, check for completeness and accuracy. See that writing is concise, and covers the topic clearly. Then check for spelling and grammar. Also see that abbreviations and acronyms are expanded.