architecture-docs

What problem does it solve?

This Skill addresses the challenge of understanding complex software systems by generating clear, concise architectural documentation, making it easier for new developers to onboard and for the team to maintain a shared understanding of the system.

Core Features & Use Cases

• System Overview: Provides a high-level summary of the system's purpose, audience, and design principles.
• Component Documentation: Details individual components, their responsibilities, technologies, and interfaces.
• Diagram Generation: Creates visual aids like component and sequence diagrams using Mermaid syntax.
• Dependency Mapping: Lists external services and their impact on the system.
• Architectural Decision Records (ADRs): Links to or helps create ADRs for key design choices.
• Development Setup Guide: Includes instructions for setting up the development environment.

Quick Start

Use the architecture-docs skill to document the system architecture for the current project.