architecture-md-builder

Solid

Build comprehensive ARCHITECTURE.md files following matklad's canonical guidelines — bird's-eye views, ASCII/Mermaid diagrams, codemaps, invariants, and layer boundaries. Triggers on document the architecture, create ARCHITECTURE.md, map this codebase, architectural overview.

Data & Documents 41 stars 3 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
54
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Architecture.md Builder Create production-quality ARCHITECTURE.md files that serve as definitive maps of any codebase, following matklad's canonical guidelines with modern AI-agent documentation patterns. ## When to Use This Skill - Creating architecture documentation for a new or existing repository - Auditing a codebase to understand its structure - Onboarding documentation for developers and AI agents - User asks to "document the architecture", "create architecture.md", or "map this codebase" ## Core Principles (matklad's Guidelines) The canonical ARCHITECTURE.md follows these principles: 1. **Bird's eye overview** - Problem being solved, high-level approach 2. **Coarse-grained codemap** - Modules and relationships (country-level, not state-level) 3. **Named entities** - Important files, types, modules by name (no links, use symbol search) 4. **Architectural invariants** - Constraints, what is NOT done, absence patterns 5. **Layer boundaries** - Transitions between systems 6. **Cross-cutting concerns** - Issues spanning multiple modules See `references/matklad-guidelines.md` for detailed explanations. ## Workflow ### Phase 1: Research Best Practices (Optional) If unfamiliar with architecture documentation patterns, use Exa search: ```bash # Search for exceptional architecture.md examples python3 ~/.claude/skills/exa-search/scripts/exa_search.py \ "architecture.md documentation best practices" \ --category github -n 10 # Find matklad's original guidelines ...

Details

Author
tdimino
Repository
tdimino/claude-code-minoan
Created
7 months ago
Last Updated
yesterday
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category