Google Technical Writing - My Notes

https://developers.google.com/tech-writing/one

Use Active Voice

Do - An actor must act on a target. (The cat sat on the mat.)

Don't - The target is being acted on by an actor. (The mat was sat on by the cat.)

  • was interpreted as
  • is generated by
  • was formed by
  • is frozen by

Clear sentences

  • Use strong verbs. Avoid weak verbs: forms of be: is, are, am, was, were, etc, occur, happen
  • Reduce there is/there are Avoid starting a sentence with there is and there are.
  • Focus each single on a single idea.
  • Use lists
  • Eliminate unneeded words Causes the triggering of -> triggers