1. STAEDEAN documentation guidelines and processes
  2. Documentation guidelines
  3. General documentation guidelines

Keep it focused

To keep your documentation focused:

  • Always mention who or what does something.
  • Address the reader. Use ‘You…’ or the imperative.
  • Use the active simple present as much as possible.
  • Avoid the 'present participle' verb form as much as possible. (Verbs with the '-ing' extension)
  • Avoid negatives as much as possible.
  • When appropriate, use an article (the, a, an) before a noun.
  • Write in the sequence you do something.