Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
A direct command skips the review prompt. Inspect the source before running it.
Create comprehensive architecture documentation using the arc42 template structure (12 sections covering introduction, constraints, context, solution strategy, building blocks, runtime, deployment, concepts, decisions, quality, risks, and glossary).
arc42 Architecture Documentation
Purpose
Generate complete, structured architecture documentation following the proven arc42 template (https://arc42.org/). The template provides 12 standardized sections covering all aspects of software architecture, from stakeholder requirements to technical implementation details.
When to Use This Skill
Starting a new project that needs comprehensive architecture documentation
Documenting existing systems that lack structured architecture descriptions
Creating architecture overviews for stakeholders with different technical levels
Preparing architecture documentation for certification (e.g., iSAQB)
Establishing a consistent documentation standard across multiple projects
arc42 Template Overview
The arc42 template consists of 12 sections:
Introduction and Goals - Requirements overview, quality goals, stakeholders
Constraints - Technical and organizational limitations
Context and Scope - System boundaries, external interfaces
Solution Strategy - Fundamental architectural decisions
Building Block View - Static decomposition (components, modules)
Fill remaining sections based on available information
Progressive approach: It's acceptable to mark sections as "TBD" and fill them over time. The document is a living artifact.
Use edit/editFiles to make changes, NOT terminal text editors or sed/awk commands.
6. Add Visual Diagrams
Update your todo as you add diagrams.
For key sections, create Mermaid diagrams using edit/editFiles:
Section 3: Context diagram (C4 Level 1)
Section 5: Component diagram (C4 Level 2/3)
Section 6: Sequence diagrams for critical scenarios
Section 7: Deployment diagram
Use the mcp-mermaid tool to preview diagrams before committing.
7. Link Existing ADRs
Update your todo when complete.
Use search/codebase to find all ADR files matching adr-*.md, then in Section 9 (Architecture Decisions):
List all existing ADRs
Provide a brief summary of each decision
Link to the full ADR file
Use edit/editFiles to update the section.
8. Validate Completeness
Review and check your todo list:
All 12 sections exist (even if marked TBD)
At least sections 1, 3, 4, 5 are filled with meaningful content
Diagrams are included for context and building blocks
Glossary includes domain-specific terms
No arc42 help text remains in the document
9. Update Documentation Index
Use edit/editFiles to add reference to the arc42 document in docs/architecture.md:
## Comprehensive Architecture Documentation
For a complete architecture overview following the arc42 standard, see:
- [arc42 Architecture Documentation](architecture/arc42/architecture.md)
10. Commit the Documentation
Mark your todo complete, then use terminal for git operations only:
