Best Practices In Technical Writing

 

      Writing Style

 

 

1.      Decide on a tense in your document and use that tense consistently. Usually the present tense is

      preferred although the past tense may make sense in certain reports.

2.      If you introduce multiple concepts and then discuss them in more detail, keep the order of

      discussion the same as the order you introduced them.

      For example, if I write a report on India, China, and Indonesia the first section would discuss India,

      the second China, the third Indonesia.

3.      Avoid run-on on sentences, even if they are grammatically correct. Short, concise sentences are best.

4.      Avoid using possessive words. Instead of “the system’s mass” use “the mass of the system.

5.      It is commonly held that passive voice is acceptable in scientific and technical writing.

      However, overuse of passive voice in long and complicated sentences can cause readers to lose interest

      or to become confused.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 
 
   

                                     Best Practices In Technical Writing

      Formatting

 

1.      The format (font type, font size, numbering of figures/tables/equations, citations,

      justify/left align text,  numbers/units, footnotes, etc.) must be consistent throughout your technical report.

2.      Be consistent with how you reference values, units and subscripting/superscripting. For example

1.      “50kg,” “50-kg,” or “50 kg”;

2.      “20 N/m^2” or “20 N/m 2,

3.       “H2” or “H2”

3.      Check if the format is in compliance with existing guidelines.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

                        

                       

                                     FAQs On Technical Writing

1. In what areas are technical writers needed?

Technical writers are found in a variety of fields including finance, engineering, healthcare, biotechnology, scientific research, academia and computer software and hardware. Smaller companies may use contract technical writers or have only a single technical writer in-house. Larger firms may have teams of technical writers working on large-scale projects

2.What qualifications are needed to go into this field?

Facility with language and document design is primary, including an eye for conciseness and precision         with facts and expression. Since nobody can be expert in every discipline, moreover, technical writers need to keep up an interest in whatever fields they write for.

 

3. What types of documents do technical writers create?

The range of writing a technical writer performs varies widely. Much is dependent on the technical specialty of the writer and of the needs of the company. You may find yourself a part of one large project, or overseeing dozens of smaller projects. You might write manuals, articles, proposals, white papers, product descriptions or any of a hundred other types of documents.