documenting-architecture

wmeints's avatarfrom wmeints

Use this skill when modifying or creating architecture documentation.

⭐2stars🔀0forks📁View on GitHub🕐Updated Jan 3, 2026⬇️2downloads

When & Why to Use This Skill

This Claude skill streamlines the creation and maintenance of comprehensive software architecture documentation. It provides a structured framework for documenting technical goals, constraints, and system views while integrating industry-standard visualization tools like Mermaid and C4 diagrams to ensure architectural clarity and consistency.

Use Cases

  • Drafting new system architecture documents including introduction, goals, and solution strategies for stakeholders.
  • Visualizing complex system interactions and runtime flows using Mermaid sequence diagrams and C4 models.
  • Maintaining a historical record of technical choices by integrating with ADR (Architecture Decision Record) workflows.
  • Updating deployment and building block views to reflect infrastructure changes or microservices evolution.
  • Standardizing technical documentation across engineering teams using predefined templates for constraints and context.
namedocumenting-architecture
descriptionUse this skill when modifying or creating architecture documentation.

Documenting architecture

Use this skill to make changes to the architecture documentation in the project following the guidelines described below.

Guidelines for specific sections

  • Introduction and goals: ./references/01-introduction-and-goals.md
  • Constraints: ./references/02-constraints.md
  • Context and scope: ./references/03-context-and-scope.md
  • Solution strategy: ./references/04-solution-strategy.md
  • Building block view: ./references/05-building-block-view.md
  • Runtime view: ./references/06-runtime-view.md
  • Deployment view: ./references/07-deployment-view.md
  • Concepts: ./references/08-concepts.md

Recording decisions

IMPORTANT: Make sure to use the record-adr skill to record decision records!

Diagrams

  • Use mermaid to record diagrams
  • Prefer to use C4 diagrams where possible, otherwise use block diagrams
  • Prefer to use sequence diagrams for recording runtime scenarios or program flows