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

Keep it simple

To keep your documentation simple:

  • Create short sentences of 10-20 words, with a max of 25 words.
  • Use just one topic per sentence. So, do not try to say too much in one sentence.
  • Use one subject per paragraph.
  • Use lists whenever possible. Use numbered lists only for procedures where the sequence is important. In all other cases, use bulleted lists.