Design Standards¶
Templates, guidelines, and quality models for consistent architecture documentation
The NovaTrek Architecture Practice maintains a curated set of design standards that ensure consistency, quality, and traceability across all architectural work. These standards are organized into five categories.
arc42 Template¶
The 12-section documentation framework for software architecture. Provides a proven structure for capturing system context, building blocks, runtime behavior, deployment, decisions, and quality requirements.
C4 Model¶
Hierarchical diagramming approach with four zoom levels — System Context, Container, Component, and Code. Includes notation guide, PlantUML macros, and a review checklist.
MADR¶
Markdown Any Decision Records — the standard format for documenting architecture decisions. Full and short templates plus worked examples.
ADR Templates¶
Three alternative ADR formats for different contexts: Nygard (minimal), Alexandrian (pattern-based), and Tyree-Akerman (business-oriented).
ISO 25010 Quality Model¶
The international standard for software product quality. Eight quality characteristics with sub-characteristics, definitions, and example quality scenarios for architecture evaluation.
How These Standards Work Together¶
| Activity | Primary Standard | Supporting Standards |
|---|---|---|
| New service documentation | arc42 template (Sections 01-12) | C4 Model for diagrams, ISO 25010 for quality requirements |
| Architecture decision | MADR full template | ISO 25010 for quality attribute assessment |
| Quick design spike | MADR short template | C4 Model (Level 2 Container diagram) |
| Business-facing decision | Tyree-Akerman ADR template | ISO 25010 for stakeholder quality concerns |
| Diagram review | C4 diagram checklist | C4 notation guide, C4-PlantUML guide |
| Quality assessment | ISO 25010 quality tree | arc42 Section 10 (Quality Requirements) |
Getting Started
First time writing architecture documentation? Start with the arc42 template for full system documentation or the MADR short template for a quick decision record.
Need to create a diagram? The C4-PlantUML guide has ready-to-use code examples for System Context, Container, and Component diagrams.