Skip to content
v0.1.0CC-BY-SA-4.0

Generate arc42 architecture documentation from a codebase. Reads the repo into a structured evidence base, then writes the 12 arc42 sections (Mermaid diagrams where the code gives high-confidence structure, explicit GAP flags where human input is needed — never fabricated). Knowledge base derived from the arc42 framework under CC BY-SA 4.0.

arc42-framework

Generate arc42 architecture documentation from a codebase. Read the repository into a structured evidence base, then author the 12 arc42 sections — emitting Mermaid diagrams where the code gives high-confidence structure, and explicit typed GAP flags where human input is needed, never fabricating. Use when asked to create, scaffold, or update arc42 docs, an architecture document, or per-section architecture views (building block view, runtime view, deployment view, etc.) for a project.

consistency-checker

Phase C subagent for the arc42 generator. Validates the generated docs/arc42/*.md sections against all cross-section consistency rules in consistency-rules.md and the machine-checkable rows of lint-checklist.md. Returns a structured violations report listing rule id, offending section, and a one-line detail. Reads only — never modifies any file.

drift-check

[PHASE 2 — NOT IMPLEMENTED] Re-read the target repository, re-derive fact records, compare against existing claim anchors in docs/arc42/, and report contradictions. Human-provided content is exempt from drift detection.

evidence-scout

Phase A subagent for the arc42 generator. Scans a target repository (or a sub-path in a monorepo) and writes a structured fact-record evidence base to docs/arc42/_evidence.md. Reads source, build files, IaC, manifests, and CI descriptors as primary evidence. Never fabricates — unknowns are absent, not invented.

fill-gaps

Walk through each open GAP flag in docs/arc42/_gaps.md, prompt for human input, write the answer into the relevant section file, re-tag that sub-section's arc42-meta provenance to human-provided, and remove the resolved GAP flag from _gaps.md. Resumable and idempotent — gaps already tagged human-provided are skipped automatically.

gap-check

[PHASE 2 — NOT IMPLEMENTED] Check docs/arc42/ for missing topic coverage against the expected-topics catalog, excluding generated GAP flags. Reports which arc42 topics have no documented coverage in the generated sections.

generate

Generate a complete arc42 architecture documentation set for a target repository. Runs evidence-scout (Phase A), all 12 section-author agents in dependency-ordered parallel waves (Phase B), and consistency-checker followed by index and GAP aggregation (Phase C). Pass an optional sub-path to scope a monorepo component.

section-author

Phase B subagent for the arc42 generator. Writes exactly one arc42 section file from its derived spec, the shared evidence base, and the upstream section files injected by the orchestrator. Uses ONLY recorded facts — never fabricates. Emits typed GAP flags for missing or human-only content. Produces a fully annotated Markdown file conforming to output-conventions.md.