architecture-documenter

What problem does it solve?

This Skill ensures your architecture documentation remains accurate and up-to-date by guiding you to inspect current systems and reconcile changes. It prevents documentation drift, fostering better understanding and collaboration.

Core Features & Use Cases

• Automated Document Maintenance: Helps maintain and update key architecture documents like system overview, cloud, service, and CI/CD architectures.
• Reality-Based Documentation: Prioritizes tool-based inspection of code, configs, and infrastructure to reflect the actual system state.
• Mermaid Diagram Generation: Integrates Mermaid diagrams into documentation for clear, visual representation of system components and flows.
• Use Case: Your cloud architecture has recently changed due to a new Kubernetes deployment. This Skill helps you update cloud-architecture.md, ensuring the diagrams and descriptions accurately reflect the current infrastructure.

Quick Start

Generate a system-overview.md document for our current application, including a high-level Mermaid diagram of its major components.