jQAssistant Lunch – March 2022: Word, Wiki or Code? Where and how should I document my architecture?

jQAssistant Lunch – March 2022: Word, Wiki or Code? Where and how should I document my architecture?

Keine Kommentare zu jQAssistant Lunch – March 2022: Word, Wiki or Code? Where and how should I document my architecture?

Have you ever got the feeling that documenting your software architecture with Word, PowerPoint or Wikis somehow doesn’t work?

We invite you to join our next lunch session on 03.03.2022 at 12:00 (CEST)!

We’ll dive into this topic discussing the problems behind and taking a deep look into what actually is required, e.g.

  • Who are the stakeholders and what’s an appropriate good structure for architecture documentation?
  • How can be ensured that the documentation remains maintainable over a long time and is always up-to-date with the code?
  • Where should documents be located and what are good file formats to choose for texts and diagrams?

Finally we’ll present our approach „to do it the right way“ – based on arc42 & Architecture Decision Records (ADRs), Asciidoc & PlantUML and – of course – jQAssistant!

If you’re interested please register here.

In case you missed our February session about Finding Log4j you’re invited to watch our recording (German language):

About the author:

@dirkmahler

Leave a comment

Back to Top