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.

                       

Freelancing

So many people are now opting for freelance work. There are certain advantages and disadvantages on freelancing. As far as the advantages are concerned- you are the boss and need not take instructions from anybody, you can work according to your own convenience at your own place,you can employ any body you want, you can charge any amount you want etc. But at the same time there are certain disadvantages also - there is no definite and fixed amount of revenue generation, you have to bid and get project, there is uncertainty of work etc.

Internet connection and a personal computer- these are the only resources required to do freelancing.No doubt one should have expertise in at least one domain - web design, writing, internet research, copy writing,logo design ......

Article Writing

What is an article?

Article is a collection of words; describing about a specific topic.
The author of the article should have knowledge on the topic on which the article is written. He should also have the ability to write in that particular language-knowledge of the grammar,syntax and vocabulary.

The next question is - who are the readers? Is the topic oriented towards a particular class or group of people; for example students,senior citizens, scientists,ladies,politicians?

An article has the following sections - heading,introduction,body and conclusions. The books and magazines referred in writing can be given in the bibliography. Figures,tables can be included if so required.

What should be the ideal length of an article? This is very difficult to define.It depends on the subject and how the author is able to explain the subject matter in a clear and lucid manner. However on an average about 500 words are quite reasonable.

The author should try to explain in a simple and straightforward manner; flowery language should be avoided as far as possible.The syntax and grammar of the language should be strictly adhered to.

http://raamachandra.com