architecture-review-doc

name	architecture-review-doc
description	Author compact canonical source for an ARCHITECTURE review (artifact_type architecture-review) — decisions, constraints, interfaces, deployment context, alternatives, and interaction diagrams. Produces content-only YAML/JSON validated against the base + architecture overlay schema; render with render-branded-html. Use for architecture/engineering reviews.

architecture-review-doc

Authors content only for an architecture review. Emit canonical YAML/JSON — no HTML/CSS/JS. Target 2–12 KB. The renderer owns all chrome.

Required & overlay fields

• Base: schema_version: 2, artifact_type: architecture-review, title.
• Overlay: decisions[] ({title, rationale?, status?}), constraints[], interfaces[], deployment_context, alternatives[].

Section shape (default)

1. context — prose: what the review covers and why.
2. sequence (or topology) — mermaid sequence/flowchart (one diagram, < 40 lines): the key interaction or component layout.
3. findings — table: columns [finding, severity, recommendation].

Use summary[] for the executive summary (top gaps/risks). Cite ADRs and code in evidence[] as {label, href}.

Widgets (schema v2)

Beyond prose/mermaid/table, sections may use: (note/tip/warning/danger), (KPI numbers), , (generic/decision/rejected/persona), , (+), (2–6 alternatives), (collapsible deep-dive), , , . Pick the widget that matches the data — and show restraint: per document; prefer when nothing structural is gained. Give every section a ; pairs small sections side by side under the skin.