architecture

Generate and update ARCHITECTURE.md with Mermaid diagrams and PDF exports.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/escotilha/claude-public --skill architecture-escotilha
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture
Source: https://github.com/escotilha/claude-public/tree/main/skills/architecture
Command: npx skills add https://github.com/escotilha/claude-public --skill architecture-escotilha

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents architecture documentation from becoming stale by automatically generating and incrementally updating a complete, diagram-rich software architecture document for your repo.

Core Features & Use Cases

  • Architecture doc generation & maintenance: Builds a structured ARCHITECTURE.md covering system overview, components, data, APIs, deployment, security, integrations, and observability.
  • Incremental updates: Detects repo changes since the last run and updates only affected sections instead of rewriting everything.
  • Mermaid diagrams + exports: Produces Mermaid-based diagrams, keeps versioned backups (last 3), and can export documentation to PDF or DOCX for stakeholders.
  • Change-triggered workflow: Useful after significant architecture/codebase changes like new services, DB migrations, API routes, or infra updates.
  • Audit-friendly history: Maintains a meta file with git SHA, timestamps, and update summaries to support traceability.

Quick Start

Run /architecture md to generate or update docs/architecture/ARCHITECTURE.md using incremental detection of changes.

Frequently Asked Questions about architecture

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

FAQPage Schema
How do I automatically generate software architecture documentation with Mermaid diagrams?▼

You can generate software architecture documentation with Mermaid diagrams by running a command that builds a structured ARCHITECTURE.md file covering system overview, components, data, APIs, and deployment for your codebase.

How do I update architecture documentation after a git commit or database migration?▼

To update architecture documentation after a git commit, the tool detects repo changes against the last recorded git SHA and incrementally updates only affected sections instead of rewriting the entire document.

Can I export my architecture documentation to PDF or DOCX for stakeholders?▼

Yes, you can export architecture documentation to PDF or DOCX for stakeholders using the built-in export pipeline that renders Mermaid diagrams for portable, shareable output formats.

What is the best way to maintain audit-friendly architecture history with version backups?▼

Maintaining audit-friendly architecture history involves saving a meta file with git SHA, timestamps, and update summaries, while keeping versioned backups of the latest three document snapshots for traceability.

Does this architecture documentation tool require any external dependencies to run?▼

No external dependencies are required to run this architecture documentation tool, allowing you to generate and maintain diagram-rich system docs directly within your existing development environment.

When should I use incremental architecture documentation updates instead of full regeneration?▼

Incremental architecture documentation updates are ideal after significant structural changes like new services, DB migrations, or API routes, whereas full regeneration suits initial setup or massive infra overhauls.