arc42-toolkit

Validates cross-section ID consistency in arc42 documentation that follows this toolkit's conventions. Checks toolkit IF-xx interface IDs (Section 3↔Section 5), building block deployment coverage (Section 5↔Section 7), Q42 quality tag traceability (Section 1↔Section 10), toolkit ADR risk references (Section 9↔Section 11), and aspirational scenario linkage (Section 10↔Section 11). Runs the automated linter script when available, or applies rules manually when not.

Interactively guides the documentation of arc42 Section 5 (Building Block View). Asks about top-level components, interfaces, and source structure before generating the Level-1 view (toolkit convention: minimum expected output) and optional deeper levels. Iterates until the user is satisfied.

Reviews any arc42 section or the full document for accuracy, completeness, cross-section consistency, and alignment with arc42 standards. Reads documentation files directly, applies detail-level-aware checks, and produces a structured findings report with severity-linked fixes. Offers to resolve Critical issues immediately using the relevant section skill.

Interactively guides the documentation of arc42 Section 1 (Introduction and Goals). Asks targeted questions about the system, quality goals, and stakeholders before generating a structured draft. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 9 (Architecture Decisions) using Nygard ADR format extended with toolkit cross-references. Asks about significant decisions, alternatives considered, and consequences before generating structured ADRs. Official arc42 only requires that significant decisions are documented; the Nygard ADR base format and the toolkit cross-reference additions are conventions, not arc42 requirements. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 10 (Quality Requirements). Elaborates quality goals from Section 1.2 into concrete, measurable scenarios grounded in Q42 quality criteria (quality.arc42.org). Coaches against vague metrics and checks coverage against architectural decisions. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 11 (Risks and Technical Debt). Pre-populates candidates from Sections 9 and 10, works through risk categories systematically, and generates a prioritized risk register and debt backlog with mitigation strategies. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 2 (Constraints). Asks about technical, organizational, regulatory, and convention-based boundaries before generating a structured draft. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 3 (Context and Scope). Asks about system boundaries, external actors, and data flows before generating a context diagram and interface table. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 4 (Solution Strategy). Asks about technology choices, decomposition approach, and how quality goals are achieved before generating a concise strategy summary. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 6 (Runtime View). Asks about key dynamic scenarios and involved components before generating C4 PlantUML sequence diagrams or step-by-step descriptions. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 7 (Deployment View). Asks about infrastructure, environments, and software-to-hardware mapping before generating C4 PlantUML deployment diagrams and environment comparison tables. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 8 (Crosscutting Concepts). Asks about domain model, security, persistence, error handling, and observability before generating only the concepts that are architecturally significant. Iterates until the user is satisfied.

Interactively guides the documentation of arc42 Section 12 (Glossary). Scans other sections for undefined terms, asks about domain vocabulary and ambiguous terminology, and generates a structured glossary with consistent preferred terms. Iterates until the user is satisfied.