software-architecture-documentation

Generate Arc42 documentation, ADRs, and fitness functions for software architecture.

5|1|Updated Jun 17, 2026
One-click install
npx skills add https://github.com/roanbrasil/engineer-grade-agent-skills --skill software-architecture-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: software-architecture-documentation
Source: https://github.com/roanbrasil/engineer-grade-agent-skills/tree/main/skills/software-architecture-documentation
Command: npx skills add https://github.com/roanbrasil/engineer-grade-agent-skills --skill software-architecture-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the risk of outdated, incomplete architecture documentation that causes onboarding delays, repeated decision debates, and undetected architectural drift, ensuring all stakeholders have access to accurate, up-to-date system context.

Core Features & Use Cases

  • Structured Arc42 Documentation: Generate lean core (6-section) or full 12-section Arc42 architecture docs tailored to project size, with templates for all standard sections including context, building blocks, runtime views, and deployment.
  • Architecture Decision Records (ADRs): Capture significant architectural decisions with full context, rationale, and consequences to avoid relitigating past choices and preserve institutional memory.
  • Fitness Functions & CI Integration: Enforce architecture rules (e.g., domain layer independence, no cyclic dependencies) via executable tests that run on every PR to prevent drift.
  • Use Case: For a new event-driven e-commerce platform, use this Skill to draft the Arc42 lean core, document the decision to use Kafka for inter-service communication via an ADR, and set up ArchUnit tests to ensure domain classes remain framework-agnostic.

Quick Start

Use the software-architecture-documentation skill to create a lean core Arc42 document and ADR index for your new order processing microservice.

Frequently Asked Questions about software-architecture-documentation

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

FAQPage Schema
How do I create Arc42 architecture documentation for a new system?

Arc42 architecture documentation is generated by creating either a lean 6-section core or a full 12-section document tailored to project size, covering context, building blocks, runtime views, and deployment.

What are fitness functions in software architecture and how do they prevent drift?

Fitness functions are executable tests that enforce architecture rules, such as domain layer independence or no cyclic dependencies, running on every pull request to prevent architectural drift.

How do I manage Architecture Decision Records to preserve institutional memory?

Architecture Decision Records capture significant decisions with full context, rationale, and consequences, preventing teams from relitigating past choices and preserving institutional memory.

Can I use the C4 model alongside Arc42 for software architecture documentation?

The C4 model can be integrated with Arc42 documentation to structure system context and building block views, ensuring maintainable architecture docs for medium to large systems.

What is the best way to document an event-driven microservice architecture?

The best way to document event-driven microservices is to draft an Arc42 lean core, document inter-service communication decisions like using Kafka via ADRs, and set up executable architecture tests.

Do I need architecture governance for a medium to large software system?

Architecture governance is needed for medium to large systems to enforce architecture rules via fitness functions, manage decision records, and maintain long-term architectural integrity.