Generate self-contained README files that enable instant developer onboarding. Use when creating or updating directory or root repository documentation. Triggers: "create readme", "readme", "document directory", "write readme", "root readme".
AI skill for generating self-contained directory READMEs that enable developers to instantly understand any part of a codebase without reading parent documentation.
READMEs are entry points, not full documentation. A developer landing on any directory should understand its purpose within 30 seconds - without needing to read the parent first.
| Principle | What It Means | | :--- | :--- | | Self-contained | Stands alone - provides its own context | | 30-second test | Purpose clear at first scan | | Loose coupling | Works even if directory moves |
readme-creation/
├── assets/
│ ├── readme-template.md # Template for generating READMEs
│ └── upgrade-from-*.md # Migration guides for breaking changes
├── README.md
└── SKILL.md # AI instructions + philosophy
Tell your AI agent:
Create a README for [directory-path]
The AI will analyze the directory and generate a self-contained README following the template.
SKILL.md - Full generation process and anti-patternsassets/readme-template.md - Copy-paste starting pointassets/upgrade-from-v3-0-0.md - Remove "Last Updated" from legacy READMEsSearch for places (restaurants, cafes, etc.) via Google Places API proxy on localhost.
Interact with GitHub using the `gh` CLI. Use `gh issue`, `gh pr`, `gh run`, and `gh api` for issues, PRs, CI runs, and advanced queries.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Start voice calls via the OpenClaw voice-call plugin.
Notion API for creating and managing pages, databases, and blocks.
Gemini CLI for one-shot Q&A, summaries, and generation.
Category:developer