0011-application-architecture-documentation.md

11. Application architecture documentation

Date: 2023-01-07

Status

Accepted

Context

We want to have a standard documentation for easy understanding of the logic of the platform and its architecture.

We research models:

• 4C model
• 4+1 model
• ARC42
• Archimate
• Diagrams.net

We research tools:

• archimate model
• archi -> neo4j -> grafana
• PlantUML
  • PlantUML-C4
• OpenAPI specification
• Gherkin
• Miro
• Notion
• diagrams

Decision

• We use the 4C model for the documentation of the application architecture.
• We use PlantUML for the documentation of the application architecture.
• We use C4-PlantUML for the documentation of the application architecture.

Architecture documentation

• C4
• Low-level schema
• Auth
• Event Sourcing

References

• Example C4 shop-service

We analyze next tools and documentation models:

• archi editor
  • C4 Model, Architecture Viewpoint and Archi 4.7
  • References:
    • RecruitmentCompany - Archimate All layers
    • Cloud Native Architectural Models using Archi

Consequences

• We have standard documentation for the application architecture.
• We use the 4C model for the documentation of the application architecture.