Translate

Thursday, August 5, 2010

Gudielines(Golden Rules) for Technical writes



• Technical writer has to bear the target audience in mind.
• The style of writing must be clear and concise. Our writing must explain about complex concepts, processes and procedures in a simple and comprehensive way.
• Be out of technical jargon.
• Just provide only those details which are required by the user.
• Pictures can speak more than words. Use one illustration instead of a lengthy paragraph wherever it is possible.
• Heading must be brief, attractive and must explain about the subject.
• Use sub-headings when you are supposed to prepare a lengthy document. They make (sub-headings) make the article readable.
• Paragraphs must be neither too big nor too small.
• Use hyper-links so that a uchandrashekarareddys@gmail.comser can directly get the details of the required topic without searching much. If it is not an electronic document, it is better to add an index of important concepts.
• The document must not be dull and dumb.
• The document must be clear and accurate.
• A technical writer has to meet Subject Matter Experts while preparing the user guide or technical document.
• Do not try to exhibit your subject knowledge entirely when you are supposed to prepare a document on a subject.
(Note: Do not follow blindly any rules including the rules that are mentioned above. Act according to the situation. Situation is the ruler of rules and the regulator of regulations).

Written by:
S. Chandrashekara Reddy
chandrashekarareddys@gmail.com


No comments: