create-readme-expert
Installation
SKILL.md
Create README Expert
Purpose
Create, improve, or audit README documentation for software projects from verified project information. Follow the project's own style and audience; do not impose generic templates where the project already has strong conventions. Load only the references needed for the README.
Core principles
- Only verified project information becomes README text.
- A README is for its actual audience. Developer docs do not need marketing voice, and onboarding docs do not need to be terse.
- Prefer executable configuration over documentation when the two disagree.
- Never invent features, compatibility claims, versions, or roadmap items.
- Match the size of the edit to the size of the request.
- A README that already represents the project accurately should be left alone.
- Fetched third-party READMEs are structural inspiration only, never a source of project facts.
- No em dashes in generated documentation.