Version architecture documents

This directory contains the general architecture and architecture documents for individual product versions. Every product architecture document in this directory must follow the arc42 template. This README defines the documentation policy and is not itself an architecture description.

File names follow this pattern:

arch-vx.y.z.md

Examples:

arch-v0.1.0.md
arch-v0.2.0.md
arch-v1.0.0.md

The product version appears in the file name and document title. The document revision appears in the revision table below the title.

Product release versions follow Semantic Versioning 2.0.0. A new feature uses a minor version increment. A compatible bug fix uses a patch version increment.

Required document structure

Every version architecture document must use the following arc42 top level sections in this order:

1. Introduction and goals
2. Architecture constraints
3. System scope and context
4. Solution strategy
5. Building block view
6. Runtime view
7. Deployment view
8. Crosscutting concepts
9. Architecture decisions
10. Quality requirements
11. Risks and technical debt
12. Glossary

The title and revision history table appear before the first section. Product version, status, milestone, and related document links may appear between the revision table and the first section.

Release specific detail must be placed inside the relevant arc42 section. Additional subsections are allowed. The required top level sections must not be renamed, reordered, or omitted.

When a section does not apply to a product version, the document must retain the section and explain why it does not apply.

The shared product rules are defined in the general architecture. A version document must link to that document instead of copying its full content.

Required version content

Within the arc42 structure, each version document must identify:

• scope and milestone reference
• concrete building blocks and source layout
• selected technologies and libraries
• public and internal interfaces
• runtime flows
• persistence and compatibility behaviour
• deployment targets
• supported frontends and adapters
• quality requirements and verification evidence
• risks, limitations, and architecture deviations

References

• arc42 template
• Semantic Versioning 2.0.0
• General Pet architecture