Individual skill
readme-writer
Write 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.
plugins/pm-devrel/skills/readme-writer/SKILL.md
Source commit e0009a385c480fb0b5687e7412df67c7c64f7cee
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Not checked yet
- Last checked
- Nov 12, 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)
- 1,541
- Repository last updated
- Nov 11, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- product-management Repository topic
- productivity Repository topic
- skills Repository topic
- claude-skills Repository topic
- agent-skills Repository topic
- chatgpt Repository topic
- claude-code Repository topic
- cursor Repository topic
- gemini Repository topic
- prompt-engineering Repository topic
- engineering Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Read excerpt
# README Writer Skill
The README is a project's front door — most people decide in seconds whether to use or bounce. This skill
writes a clear, scannable README that answers *what is this, why should I care, how do I run it* immediately,
then layers in the detail. Structured so a newcomer gets to a working result fast.
> **Not quite this?** Use `readme-benefit-writer` when you already have a README and want each feature rewritten as a user benefit.
## Required Inputs
Ask for these only if they aren't already provided:
- **Project name & one-line purpose** — what it is and what problem it solves.
- **Who it's for** — the target user/developer.