architecture-md

Community

Document your codebase architecture.

Authorcaidanw
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: architecture-md
Download link: https://github.com/caidanw/skills/archive/main.zip#architecture-md

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.