Printer-friendly version

The following is a simple checklist for technical writers:

1. Use standard, conventional English. Stick to the basics as many companies localize and translate technical documents to multiple languages. The linguistic rules and guidelines for translation are based on standard usage, and not on unconventional or nonstandard writing.

2. Use standard sentence structure. This is a major issue faced by non-native writers. Always stick to the accepted standards of writing clear and simple sentences.

3. Keep it simple and short. It is very difficult to write in a simple and clear manner. You are not writing a feature, or a philosophical treatise. Keep on rewriting.

4. Make the subject and the verb agree.

5. Use pronouns correctly. Beware of the collective nouns that take a singular verb.

6. Avoid comma splices.

7. Avoid run-on sentences.

8. Eliminate sentence fragments and redundant expressions.

9. Do not create absurd sentences with misplaced modifiers.

10. Use punctuation marks correctly. A misplaced comma can land the company in legal troubles.

11. Always refer to a standard dictionary, or a style guide for grammar and usage. When in doubt, check with your seniors. Writing improves only with constant learning. There is no shortcut to good writing.

12. Instill the habit of reading standard English daily.

PS: Do not think that it is always the editor's job to find the mistakes in your writing. Many a mistake can be avoided if you stick to the basics. Going back to Wren and Martin may hurt a few egos, but it is better to be late than never.