- “for e.g.”, use either “for example, …” or “e.g.” “E.g.” itself means “for example” so the term “for e.g.” is redundant.
- “updation”; this is not a word, use update or updated as appropriate.
- “revert” use “please reply” or “please provide an update.” “Revert” means “to return to a former condition, practice, subject, or belief.” Using “revert” as a request to reply to an e-mail or a request for information is inconsistent with this definition. Please note although revert is frequently used incorrectly in India this does not make it correct.
- Use “feedback” instead of “feedbacks”.
- Use “please do what is required” instead of “do the needful”. “Please do the needful” is often the only remark in forwarded e-mails. We should be more specific as to what action(s) we want the reader to take and by when (sometimes it is not obvious).
- Use “lessons” or “knowledge” instead of learning(s). Avoid using the word learning or learnings in the context of lessons.
Correct usage: No data migration will be required for the process that is being implemented.
Incorrect usage: No data migration would be required for the process that is being implemented.
Use click instead of click on.
Correct usage: Click the OK button or Click OK.
Incorrect usage: Click on the OK button.
Buzzwords
Note, a good rule of thumb is to try and avoid the repetition of a word within the next three lines.
Overused buzzwords: key, leverage, …
“MS Word” Tips
- Be sure to create a standard Word template that meets your requirements at the outset of each project. This will ensure that all documents have a consistent look and feel.
- When the first row of a table is used as a header it should be set to repeat if the table crosses page boundaries (select row, click on format -> table properties -> rows -> select repeat row as header on the top of each page) AND the paragraph attribute “Keep with Next” should be set for the header contents (that way you don’t end up with only the header on the bottom of a page).
- Blank lines should not be used to create white space between paragraphs and graphics, use paragraph spacing / styles instead.
- Graphics are frequently scaled disproportionately (i.e. height is 80%, and width is 50% of the original size) making any text in them hard to read as well as distorting the images.
Other Common Issues
- Sentences are too long. Keep sentence length to an average of 15 to 20 words. Longer sentences are generally harder to read.
- Frequent shifts from 3rd person (he/she/it/they) to 1st (I/we) and 2nd (you) person. Technical documents should generally be written in 3rd person (he/she/it/they) with very few, if any, exceptions.





