Tuesday, January 25, 2011

Tips on technical writing in English

  • Read the short, classic book titled The Elements of Style. (This book comes as a free sample with the free iPad app inkling.)
  • Add a space after comma. Example: For example, there is a space after the comma in this sentence.
  • Add a space before "(" and after ")".
  • Know the difference between "that" and "which". (Just google "difference between that and which".)
  • VITAL in "the VITAL Lab" is an acronym. So it should not appear as "Vital Lab".
  • Never use "I" or "me," use "we" or "us" instead. Use "we" only when absolutely necessary when it is important to stress that. Use "the authors" to replace that if possible. Use "the authors" only when necessary. If experiments are repeatable by others, then it is not important who do it. Therefore, it should not be emphasized that "the authors" did this, "the authors" did that.
  • Never use "can't". Use "cannot" instead.
  • Never use "doesn't". Use "does not" instead.
  • Every sentence, every word should be meaningful and add value to the technical paper that it belongs to. If a paragraph, a sentence, a phrase, or a word can be removed without reducing the amount of information delivered through the paper, then remove it. Here's an example: "Researchers and developers all over the world explored providing m-health service through mobile devices." Earlier in the paper, it was already explained that m-health stands for mobile-health and refers to electronic health applications on mobile devices. This sentence does not add any concrete technical value to a technical discussion and should be removed or replaced by another one with more concrete information.
  • Never use a sentence or a unique phrase from a reference without adding the quotation marks, even if the reference is properly cited.

No comments:

Post a Comment