arc42

Create, modify, and validate arc42-compliant software architecture documentation.

9|2|Updated Nov 29, 2024
One-click install
npx skills add https://github.com/bbvch-ai/aihub-core --skill arc42
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: arc42
Source: https://github.com/bbvch-ai/aihub-core/tree/main/.claude/skills/arc42
Command: npx skills add https://github.com/bbvch-ai/aihub-core --skill arc42

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing and maintaining consistent, high-quality arc42 architecture documentation is time-consuming and requires deep familiarity with both the arc42 framework and the specific project codebase, leading to incomplete or inaccurate documentation when done manually.

Core Features & Use Cases

  • Chapter Authoring: Write new arc42 chapters following official section structure, purpose, and quality criteria for all 12 framework sections.
  • Document Editing: Update existing chapters to reflect codebase, infrastructure, or architectural changes while maintaining cross-reference consistency.
  • Quality Review: Validate existing chapters against completeness checklists, quality criteria, and codebase accuracy requirements.
  • Use Case: A Swiss AI Hub platform architect can use this skill to generate a compliant Section 7 deployment view that accurately maps platform components to the Docker Compose network topology defined in the project's infrastructure files.

Quick Start

Use the arc42 skill to write a complete Section 5 building block view for the Swiss AI Hub platform, referencing the packages/core and packages/agent CL AUDE.md files for source material.

Frequently Asked Questions about arc42

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

FAQPage Schema
How do I write arc42 architecture documentation that aligns with my codebase?

To write arc42 architecture documentation aligned with your codebase, generate framework chapters using source material like CLAUDE.md files and infrastructure definitions. This ensures documentation accurately maps platform components to actual codebase and deployment topology.

What is the best way to update existing arc42 documentation after infrastructure changes?

The best way to update existing arc42 documentation after infrastructure changes is to edit affected chapters while automatically maintaining cross-reference consistency. This keeps deployment views and architectural components synchronized with modified infrastructure files.

Can I validate my software architecture documentation against official arc42 quality criteria?

Yes, you can validate software architecture documentation against official arc42 quality criteria by performing a quality review. This process checks chapters for completeness, structural consistency, and accurate alignment with source code and deployment definitions.

How does arc42 documentation handle cross-referencing between system design components?

arc42 documentation handles cross-referencing between system design components by enforcing consistent section structure across all 12 framework sections. When updating or authoring chapters, cross-references between architectural components are maintained to ensure continuous alignment.

Do I need specific deployment files to generate an arc42 deployment view?

Yes, you need specific deployment files like Docker Compose network topologies or similar infrastructure definitions to generate an accurate arc42 deployment view. The framework maps platform components directly from these infrastructure files to ensure codebase accuracy.