An opinionated variation of the arc42 Template for software architecture documentation. It is the original structure, enriched with some of the available explanations and with a toolbox ready to go.
For a quick overview of arc42, read the blog post Documenting software architecture with arc42 on innoq.com.
- Cleaned up and Github compatible Markdown
- Rendering with mdbook and Github actions
- Diagrams with mermaid
- Diagrams with plantuml
Special thanks to Dr. Peter Hruschka, Dr. Gernot Starke and contributors who created arc42, the template for documentation of software and system architecture.
See https://arc42.org.
As preconditions the following tools must be available:
- cargo (the Rust package manager, used to install mdbook)
- npm (used to manage all javascript dependencies)
- plantuml (if plantuml is used for diagrams)
Install mdbook and the javascript dependencies:
cargo install mdbook
cargo install mdbook-mermaid
cargo install mdbook-plantuml
npm install
Build & open the book:
mdbook serve --open