Level up your
documentation skills

The purpose of the onboarding program

  • Get you familiar with Revision.
  • Align you and your team on how to write good,
    modern and useful documentation.
Workshop 1 - Getting started (60 min)
  • What is "good" documentation, and who is it for
  • Modelling vs Diagramming
  • Diagramming anti-patterns and typical problems
  • An overview of the C4 model Notation and tips for better diagrams
  • Identify your level 1 diagrams
  • Software design exercise
  • Design exercise review #1
Workshop 2 - Follow up (45 min)
  • Writing lightweight supplementary documentation using a “software guidebook” or arc42
  • How much upfront design is enough
  • Software design exercise
  • Design exercise review #2
Workshop 3 - Final review (45 min)
  • C4 and UML
  • System Landscape diagrams
  • Dynamic diagrams
  • Deployment diagrams
  • Software design exercise
  • Design exercise review #3
© 2024 Revision