Stats
Actions
Tags
From m
This skill should be used when creating or updating README.md files for codebase directories. It covers LLM-optimized documentation conventions, YAML frontmatter, file listings, Mermaid diagrams, and rules for keeping READMEs current as the codebase evolves.
How this skill is triggered — by the user, by Claude, or both
Slash command
/m:code-documentationThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Conventions and templates for README.md files that serve as LLM-optimized navigation documents for codebase directories.
Conventions and templates for README.md files that serve as LLM-optimized navigation documents for codebase directories.
/m:dev Step 8 triggers documentation updatesREADME.md files are LLM-optimized navigation documents. They allow an agent to:
They are NOT traditional human-only documentation. They prioritize structured, scannable content over prose.
Every README.md starts with YAML frontmatter containing exactly three fields:
---
module: kebab-case-module-name
purpose: One-sentence description of what this directory contains and why it exists
last-updated: YYYY-MM-DD
---
module: The directory name in kebab-case. Must match the directory it lives in.purpose: A single sentence an LLM can use to decide relevance. Be specific — "GraphQL resolvers and helpers for the patient-facing API" not "patient stuff."last-updated: The date the README was last modified. Update this whenever the README content changes.Include a table listing every file in the directory (excluding the README.md itself, test directories, and generated files):
## Files
| File | Description |
|------|-------------|
| service.go | Core booking service with create, cancel, and reschedule operations |
| repository.go | Database queries for the bookings table |
| model.go | Booking domain types and validation |
Include as many Mermaid diagrams as needed to explain the module. Common types:
Small utility directories might only need the file listing. Complex modules might need 5+ diagrams. Use your judgment — include every diagram that helps understand the module.
Between frontmatter and the file listing, include a 2-4 sentence overview paragraph explaining:
If the module has important conventions, gotchas, or patterns that aren't obvious from the code, add a ## Notes section at the bottom.
Document directories containing:
Skip directories that are:
node_modules/, dist/, build/, coverage/, vendor/, .next/).git/)__tests__/) — the parent README covers what's testedprd/) — these have their own document structureUpdate a directory's README.md when:
Do NOT update the README on every code edit. Only structural changes (files added/removed/renamed) or significant interface changes warrant an update.
npx claudepluginhub molcajeteai/plugin --plugin mAudits existing docs and generates full project documentation in docs/ including architecture.md, getting-started.md, development.md, API refs, and ADRs. For onboarding and context sharing.
Provides best practices for Markdown technical documentation and READMEs, including structure, organization, linking, writing style, code examples, and admonitions.
Generates API docs, architecture diagrams, user guides, and technical references from code using AI analysis and best practices. Useful for documentation pipelines and repo standardization.