architecture-documenter

Generate and maintain architecture documentation with Mermaid diagrams under docs/architecture/.

1|Updated Dec 4, 2025
One-click install
npx skills add https://github.com/timbuchinger/loadout --skill architecture-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-documenter
Source: https://github.com/timbuchinger/loadout/tree/main/skills/architecture-documenter
Command: npx skills add https://github.com/timbuchinger/loadout --skill architecture-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about architecture-documenter

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

FAQPage Schema
How do I keep architecture documentation in sync with code changes?

Architecture documentation drifts when systems evolve faster than docs. This Skill automates documentation maintenance by inspecting your current code, configs, and infrastructure, then generating or updating docs/architecture/index.md with accurate system descriptions and Mermaid diagrams reflecting your actual architecture.

Can I generate Mermaid diagrams for cloud and CI/CD architecture automatically?

Yes. This Skill inspects your infrastructure and generates Mermaid diagrams integrated into architecture documents for system overview, cloud deployment, service design, and CI/CD flows, providing clear visual representation of components and their relationships.

What's the best way to document microservices and cloud infrastructure together?

Tool-based inspection of your codebase and infrastructure is the foundation. This Skill prioritizes introspection via tools first, then CLI fallback, to produce unified architecture documentation with service boundaries, cloud topology, and CI/CD pipelines all in one coherent doc set.

Do I need to manually update architecture docs after infrastructure changes?

No. This Skill automates the inspection and update cycle for architecture documentation. It detects infrastructure changes through tool-based code and config analysis, then updates only the relevant architecture documents while preserving manual edits elsewhere.

How does this work with existing documentation in my project?

The Skill creates and maintains docs/architecture/ with enforced lowercase dashed filenames. It integrates into your existing documentation structure, prompts for confirmation when changes are ambiguous, and updates only files it owns, leaving other docs untouched.

What do I need to prepare before generating architecture documentation?

Have your codebase and infrastructure accessible for inspection. The Skill uses tool-based introspection to read code, configs, and infrastructure state directly, then generates documentation—no manual architectural diagrams or descriptions required upfront.