Illustrating

Readers like documentation with illustration (good or bad)

1. Write caption first

  • helps to check if illustration matches goal

2. Constrain information in single drawing

  • complex block diagrams overwhelm users
  • organize into subsystems

3. Focus on reader's attention

  • e.g. add oval on important place
  • use callouts to focus users attention

4. Illustrating is re-illustrating

  • Revise and question
  • how can i simplify illustration
  • should split into two or more?
  • is text in illustration easy to read?
  • What is the takeaway

5. Illustration tools

  • google drawing
  • draw.io
  • lucidChart