Technical Writing — Mauricio Saglietto

Google (https://developers.google.com/tech-writing)
- Grammar
- Use terms consistently
  - Introduce Abbreviation
    - Abbreviation is less writing words but more cognitive work
    - Dont over use
- Use of pronouns
  - Make sure to introduce the noun first
  - Use the pronoun close to the noun if more than 5 words between use the noun
  - If you use a second noun it could be confusing to use the pronoun so you better re use the noun
  - This and That
    - Be careful when you use it.
    - Most of the time is better to just use the noun
    - Or put a noun after the this and that to make sure what are you referring too
- Use active voice
  - Active = actor + verb + target
    - The cat sat on the mat
  - Passive = target + verb + actor
    - Ex. The mat was sat on by the cat
  - Most reader have to convert passive to active so it make less work to use active voice directly
  - Passive voice can hide ideas by stating actions indirectly
  - Passive voice sometimes omit actor making the reader to identify the actor
  - Active voice is generally shorter