arc42-markdown-template
based on the principles of arc42 and the C4 model for visualizing software.
A template for architecture documentation in markdown format.
While the arc42 project provides a single markdown file as a template we have separated the individual chapters.
Images and diagrams can be stored in the central "assets" folder.
The linked pages contain the explanatory primers for each chapter provided by arc42.
The markdown files reside in the folder "docs". Additional files or subfolder structures can be added at your leisure.
- Introduction and Goals
- Architecture Constraints
- System Scope and Context
- Solution Strategy
- Building Block View
- Runtime View
- Deployment View
- Crosscutting Concepts
- Architecture Decisions
- Quality Requirements
- Risks & Technical Debt
- Glossary