Skip to content

Draft — not approved. A working draft by UASK. It may change without notice.

Blueprint (architecture and plan)

Status
Review
Version
1.1.0
Authority
Not stated
Applies to
Core
Markdown source

Definition

A blueprint is a project’s architecture description: the document that says how a product is built to meet its requirements and why. It names the stakeholders and their concerns, then covers, in twelve sections, goals, constraints, context and interfaces, solution strategy, building blocks, runtime, deployment and operations, cross-cutting concepts, decisions, quality requirements, risks and technical debt, and a glossary, with an annex that maps each requirement to a section. Every significant choice in it is recorded as an ADR.

“Blueprint” is the Hub’s name for what ISO/IEC/IEEE 42010 calls an architecture description and many teams call a design document or design doc. Its section order follows arc42, cited by reference; the text is the Hub’s own.

Example

“The search runs inside the existing web container [ADR-0008]; an external search service was rejected for cost (see the record).” In a Hub project the blueprint is project/BLUEPRINT.md, written from templates/blueprint.md.

Sources