Individual skill
crafting-effective-readmes
Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
cli-tool/components/skills/productivity/crafting-effective-readmes/SKILL.md
Source commit ad81bf053f80b626801decf425f501ba49983d98
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- Yes
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Network or broad shell
- Last checked
- Nov 4, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 33,194
- Repository last updated
- Nov 8, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- anthropic Repository topic
- anthropic-claude Repository topic
- claude Repository topic
- claude-code Repository topic
- agent-skills Repository topic
- ai-agents Repository topic
- claude-code-plugins Repository topic
- cli Repository topic
- mcp Repository topic
- registry Repository topic
- writing Derived category
- docs Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
README.mddoc · 6,035 bytesSKILL.mdcore · 2,676 bytesreferences/art-of-readme.mddoc · 24,440 bytesreferences/make-a-readme.mddoc · 6,679 bytesreferences/standard-readme-example-maximal.mddoc · 1,586 bytesreferences/standard-readme-example-minimal.mddoc · 169 bytesreferences/standard-readme-spec.mddoc · 9,864 bytessection-checklist.mddoc · 680 bytesstyle-guide.mddoc · 434 bytestemplates/internal.mddoc · 1,952 bytestemplates/oss.mddoc · 1,667 bytestemplates/personal.mddoc · 1,078 bytestemplates/xdg-config.mddoc · 1,478 bytesusing-references.mddoc · 1,325 bytes
Read excerpt
# Crafting Effective READMEs
## Overview
READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.
**Always ask:** Who will read this, and what do they need to know?
## Process
### Step 1: Identify the Task
**Ask:** "What README task are you working on?"
