best-practices-readme
Installation
SKILL.md
Best Practices: README
Use this skill to make a README useful to a developer landing cold in a repo or skill directory. The goal is not a pitch deck. The goal is a friendly map that answers: what is this, why does it exist, where do I start, what can I trust, and what is intentionally not proven here?
Core Contract
A good README is:
- Welcoming: human, light, direct, and specific.
- Navigable: the first screen gets readers to the right directory, file, command, or artifact.
- Contract-aware:
README.mdexplains;SKILL.mdgoverns runtime. - Evidence-aware: proof claims name commands, artifacts, screenshots, reports, receipts, or explicitly state non-claims.
- Public-safe: public docs expose reusable patterns, not secrets, credentials, regulated data, or private runtime details.