architecture-md

Generate an ARCHITECTURE.md file documenting codebase structure and concerns.

8|1|Updated Feb 16, 2026
One-click install
npx skills add https://github.com/caidanw/skills --skill architecture-md
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-md
Source: https://github.com/caidanw/skills/tree/main/architecture-md
Command: npx skills add https://github.com/caidanw/skills --skill architecture-md

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you create clear, concise, and maintainable ARCHITECTURE.md files, making it easier for new contributors to understand your codebase's structure and purpose.

Core Features & Use Cases

  • Architecture Documentation: Generates ARCHITECTURE.md following best practices.
  • Codebase Mapping: Helps identify modules, boundaries, and invariants.
  • Onboarding: Streamlines the process of bringing new developers up to speed.
  • Use Case: When a new developer joins your team, use this Skill to generate an ARCHITECTURE.md file that explains the project's core components and data flow, significantly reducing their ramp-up time.

Quick Start

Use the architecture-md skill to generate an ARCHITECTURE.md file for this project.

Frequently Asked Questions about architecture-md

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?

To generate an ARCHITECTURE.md file, you can use a skill that analyzes your codebase structure and automatically documents the problem solved, bird's eye view, code map, module boundaries, and cross-cutting concerns.

What should I include in architecture documentation for onboarding new developers?

Architecture documentation for onboarding should include a bird's eye view of the codebase, a code map with module descriptions, boundaries, invariants, and cross-cutting concerns to help new contributors quickly understand the project.

What is the best way to document codebase architecture for complex projects?

The best way to document codebase architecture is to create an ARCHITECTURE.md file following established principles, clearly mapping out modules, boundaries, and invariants to reduce ramp-up time for new developers.

How does an ARCHITECTURE.md generator handle module boundaries and cross-cutting concerns?

An ARCHITECTURE.md generator identifies and documents module boundaries, invariants, and cross-cutting concerns by analyzing the codebase, helping developers understand structural limits and shared dependencies across the project.

Do I need any specific dependencies to create architecture documentation for my codebase?

You do not need any specific dependencies to create architecture documentation, as this skill operates without external requirements to generate a comprehensive ARCHITECTURE.md file for your project.