SA-201c · Module 1
The Documentation Pyramid
4 min read
Most architecture documentation fails because it is written at a single level of detail. A 60-page architecture document is comprehensive and unread. A one-page diagram is readable and insufficient. The solution is a pyramid — layered documentation at three levels of detail, each serving a different audience and a different purpose. The reader enters at the level they need and goes deeper only when they must.
- Level 1: The Overview (1 page) The 5-minute architecture. One page. What the system does, what goes in, what happens inside, what comes out, and what protects it. This level serves executive stakeholders, new team members, and anyone who needs to understand the system without building it. If this page does not exist, every explanation of the architecture starts from zero.
- Level 2: The Component View (5-10 pages) The major components, their responsibilities, their interfaces, and their interactions. Data flow diagrams, integration surfaces, and technology selections with rationale. This level serves technical leads, integration partners, and the team that will extend the system. Detailed enough to design against. Brief enough to maintain.
- Level 3: The Implementation Detail (per-component) Detailed design for each component: data models, API specifications, configuration, deployment procedures, and operational runbooks. This level serves the engineers who build and maintain each component. It lives close to the code — in the repository, not in a separate document system — because documentation that is separated from the code it describes drifts immediately.
Do This
- Build all three levels — overview, component view, and implementation detail
- Keep the overview current — it is the most read and the most frequently stale
- Store implementation documentation alongside the code it describes
Avoid This
- Write a single monolithic architecture document — it will be comprehensive and unread
- Skip the overview because "everyone knows the system" — new team members, executives, and future you do not
- Store documentation in a system separate from the code — separation guarantees drift