architecture-md-builder

Generate ARCHITECTURE.md files by exploring codebase structure and documenting invariants.

41|3|Updated Jan 2, 2026

Search Tags:#architecture #documentation #technical writing #developer onboarding #code structure #codebase mapping

Ready to run

npx skills add https://github.com/tdimino/claude-code-minoan --skill architecture-md-builder

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: architecture-md-builder
Source: https://github.com/tdimino/claude-code-minoan/tree/main/skills/core-development/architecture-md-builder
Command: npx skills add https://github.com/tdimino/claude-code-minoan --skill architecture-md-builder

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires exa-search, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive ARCHITECTURE.md files, transforming complex codebases into easily understandable maps for developers and AI agents.

Core Features & Use Cases

Automated Documentation: Generates ARCHITECTURE.md following established best practices (matklad's guidelines).
Codebase Mapping: Creates bird's eye views, codemaps, invariant definitions, and layer boundary diagrams.
Use Case: When starting a new project or onboarding a new team member, use this Skill to quickly generate a clear, high-level overview of the entire codebase's structure and key components.

Quick Start

Use the architecture-md-builder skill to create an architecture.md for this repository.

Frequently Asked Questions about architecture-md-builder

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

FAQPage Schema

How do I generate an ARCHITECTURE.md file for my codebase?▼

Generate an ARCHITECTURE.md by running this Skill against your repository to explore codebase structure, identify key abstractions, and document architectural invariants and layer boundaries automatically.

What is the best way to document code structure for developer onboarding?▼

Documenting code structure for developer onboarding is best handled by generating a comprehensive ARCHITECTURE.md that maps key abstractions, architectural invariants, and layer boundaries into a clear high-level overview.

Can I automate technical writing for architectural documentation?▼

Yes, you can automate technical writing for architectural documentation by using this Skill to explore your repository and produce a comprehensive ARCHITECTURE.md following established best practices.

Do I need Python to map my codebase and document architectural invariants?▼

Yes, you need Python installed because this Skill relies on Python scripts during the codebase exploration and verification phases to accurately map structure and document architectural invariants.

Does the architecture-md-builder work with exa-search for codebase mapping?▼

Yes, the architecture-md-builder works with exa-search as a required dependency to facilitate codebase exploration and mapping during the generation of your architectural documentation.

When should I not use automated architecture documentation generation?▼

You should avoid automated architecture documentation generation when your repository lacks clear architectural invariants or layer boundaries, as the tool requires identifiable abstractions to map the codebase effectively.