readme-best-practices
From the author
Structure, tone, and content conventions for writing effective project README files, covering hooks, quick starts, feature presentation, badges, and common documentation sections. Use when writing a new README, rewriting an existing one, or reviewing README quality for a repository, library, or CLI tool.
Install
npx skills add Mindrally/skills --skill readme-best-practices -a claude-code
Installs to .claude/skills/readme-best-practices/ · Each command fetches the skill straight from GitHub with the open skills CLI.
Byte-identical to the scanned commit, with the repository’s licence and a SOURCE.txt.
Want your agent to suggest skills while you type? See how to use skills from your IDE.
Safety checks on SKILL.md
No warnings.
Why 85
aiqbench computes the trust score from public signals. It is not a security audit, so read a skill before you install it.
Similar skills
Closest to this one by what they do and when they are used.
- crafting-effective-readmessoftaworks/agent-toolkitUse when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.Writing★ 2.6K
- readme-writermohitagw15856/pm-claude-skillsWrite a clear, well-structured README for a software project or open-source repo. Use when asked to write or improve a README, document a project, or make a repo approachable. Produces a complete README — one-line pitch, badges, quickstart, usage, install, contributing, license — that gets someone from landing to running fast.Writing★ 1.5K
- good-readmeevilmartians/agent-skillsWrite or improve a README.md for an open source project. Use this for any request to create, rewrite, review, or polish a README, project description, or "getting started" docs for a library, framework, or tool, or to make an open source project more popular or attractive to users. Do NOT use for internal/private repo docs, API reference generation, or CHANGELOG/CONTRIBUTING files.Writing★ 52
- write-docsdzhng/skillsWrite and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.Writing★ 1.4K
- writing-guidelinesvercel-labs/agent-skillsReview docs/prose for Writing Guidelines compliance. Use when asked to "review my docs", "check writing style", "audit prose", "review docs voice and tone", or "check this page against the writing handbook".OfficialWriting★ 33.5K
- readmesickn33/agentic-awesome-skillsYou are an expert technical writer creating comprehensive project documentation. Write an accurate README sized to the project and task, with verified setup instructions and links to detailed references.Writing★ 49.1K
Ratings & reviews
—
no reviews
Tried this skill? Rate it to help others. Sign in
Discussion
Join the discussion. Sign in