Wednesday, November 30, 2011

What is Technical Writing?


"What on earth is Technical writing?" my friend asked me wryly without taking his eyes off his new-found obsession. He had just bought a brand new BlackBerry, much against his parents' wishes, and had been all over it ever since, like a child with a new toy.

He blurted some gibberish as he proceeded to fiddle with all of its functions at once, so I reminded him again to use the technical manual that came with it. I gave him the user manual and said,"This user manual here, my friend, is nothing but technical writing."

Tuesday, November 29, 2011

Concepts of Technical Writing

Let us explore the fundamental concepts of Technical communication. There are basically three important concepts or traits of  technical communication
 a) Audience centered
 b) Presentation
 c) Responsibility 

Monday, November 28, 2011

Technical Writing Basics

Technical Writing is a specialized type of writing covering a technical product or process that involves conversion of technical terms or jargons to structured forms and formats, as the writer intended to project the product or process and would want the end-user to act when confronted with technology.


Aim of Technical Writing
The foremost aim of technical writing is to persuade the users of technology to change the way they were doing things and convince the readers of technical documentation to change their using behavior, so they know how to  use technology optimally.

Objective of Technical Writing
The objective of technical writing is to change the technical terms to simple terms by stressing more on the technology involved rather than the technicalities of a product or process.

Names a Technical Writer takes

Technical writers are known in industry circles by different names. Some call them technical communicators, others call them software documentation experts or information developers, but for our purposes, we can simply call them technical writers.

Wednesday, November 23, 2011

General Rules of Technical Writing

Here are some general rules that you need to follow while writing your documentation.

 1. Accuracy. This is the most important rule of technical writing. The onus of maintaining the correctness and accuracy of a document rests with the technical writer. The document should be checked and re-checked for accuracy.

2. Well-Organized. The documentation should be in an organized manner.  The chapters and sections should be logically connected and should have an even flow. Technical documents are designed and arranged to provide information, beginning with a general point of view and later followed by more specific aspects of the product.

3. Comprehensive.  Technical writing should be exhaustive and comprehensive. It should cover all the aspects of the technology. Skipping a step or functionality because it appears trivial to you or irrelevant for the user could adversely impact user experience.

4. Precision. You should not leave any room for ambiguity. A word or an expression used in the document should not convey more than one meaning.

5. Compactness. The information should look compact, yet complete, without any loose ends. Restrict creativity in writing and practice austerity in the choice of words.

6. Consistency. There should be consistency in the use of vocabulary and style. If a technical jargon is called a certain way in the first page, do not replace it with an another name in some other part of the document.


Saturday, November 19, 2011

Scope of Technical Writing in India


In today's customer-centric environment, businesses are increasingly conscious of the information and technical write up that accompanies their product. The technical documentation is treated as an important aspect of product development and packaging. For a professionally managed company, especially a software services organization, the user manual and documentation represent their level of professionalism and commitment.


Friday, November 18, 2011

What does it take to be a Technical Writer?

Do I have what it takes to be a technical writer? If you are seeking the answer to this question, read on. The five must have skills that any technical writer should possess are summarized here.


Aptitude for Technology
It is often presumed that a technical writer should be first, and foremost, tech-savvy to be effective. Although true to an extent, it does not really add up to the quality of writing, as the person who is tech-savvy will need to think and write like a novice to be on a level playing field with the user. It is never easy to fathom how little a first-timer   knows when you are already an expert. It is like going down stairs backwards. Being technologically challenged allows you to learn, and in the process helps you relate to the user and address their concerns in a better way. Having an aptitude for technology is, however, a prerequisite. An inherent ability to learn and adapt quickly gives you an edge over others.