arch-document

Generate all twelve arc42 sections and diagrams from architecture briefs and ADRs.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/cjennings/rulesets --skill arch-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: arch-document
Source: https://github.com/cjennings/rulesets/tree/main/arch-document
Command: npx skills add https://github.com/cjennings/rulesets --skill arch-document

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produce a complete arc42-structured architecture document from a project's architecture brief and ADRs. Generates all twelve arc42 sections (Introduction & Goals, Constraints, Context & Scope, Solution Strategy, Building Block View, Runtime View, Deployment View, Crosscutting Concepts, Architecture Decisions, Quality Requirements, Risks & Technical Debt, Glossary). Dispatches to the c4-analyze and c4-diagram skills for building-block, container, and context diagrams. Outputs one file per section under docs/architecture/. Use when formalizing an architecture that already has a brief + ADRs, preparing documentation for a review, onboarding new engineers, or satisfying a compliance requirement. Do NOT use for shaping a new architecture (use arch-design), recording individual decisions (use arch-decide), auditing code against an architecture (use arch-evaluate), or for simple systems where a brief alone suffices. Part of the architecture suite (arch-design / arch-decide / arch-document / arch-evaluate + c4-analyze / c4-diagram for notation-specific diagramming).

Core Features & Use Cases

  • Generates all twelve arc42 sections (Introduction & Goals, Constraints, Context & Scope, Solution Strategy, Building Block View, Runtime View, Deployment View, Crosscutting Concepts, Architecture Decisions, Quality Requirements, Risks & Technical Debt, Glossary)
  • Dispatches to c4-analyze and c4-diagram skills for corresponding diagrams
  • Outputs one file per section under docs/architecture/ to support reviews, onboarding, and compliance

Quick Start

Run arch-document with your architecture brief and ADRs to generate the full arc42 document under docs/architecture/.

Frequently Asked Questions about arch-document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate arc42 architecture documentation from existing ADRs?

To generate arc42 architecture documentation from ADRs, provide an architecture brief and available ADRs as input. The system produces all twelve arc42 sections as separate files under docs/architecture/, cross-linking the ADRs and dispatching diagrams automatically.

What is the best way to create architecture docs for engineering onboarding from a project brief?

Creating architecture docs for onboarding from a project brief is best handled by generating a complete arc42-structured document. It outputs one file per section under docs/architecture/, providing new engineers with standardized, comprehensive system context and decisions.

Can I auto-generate C4 diagrams alongside arc42 sections for compliance documentation?

Yes, you can auto-generate C4 diagrams alongside arc12 sections for compliance documentation. The process dispatches to c4-analyze and c4-diagram skills to produce building-block, container, and context diagrams within the generated architecture files.

Do I need an architecture brief and ADRs before generating full architecture documentation?

Yes, an architecture brief and ADRs are required before generating full architecture documentation. The system applies when a brief exists and ADRs are available, using them as inputs to validate, plan, and populate all twelve arc12 sections.

When should I not use arc42 documentation generation for my software architecture?

You should not use arc42 documentation generation when shaping a new architecture, recording individual decisions, auditing code, or for simple systems where a brief alone suffices. It is designed for formalizing existing architectures that already have a brief and ADRs.

Why does my generated architecture documentation split into multiple files under docs/architecture/?

Generated architecture documentation splits into multiple files under docs/architecture/ to output one file per arc42 section. This structure supports granular reviews, easier onboarding, compliance checks, and includes an auto-generated index for navigation.