README Polish
SkillDev toolsImprove a README for clarity and completeness. Use when a junior developer needs guidance on documenting setup and usage.
Available today. Use it from your connected AI after setup.
No other account needed.
Connect ahel once, and every AI you use reads what you have installed.
Then ask your AI: use the README Polish skill
What this skill tells your AI
The instructions your AI receives, as published by proflead/codex-skills-library in skills/docs/readme-polish/SKILL.md and read by ahel’s review.
Purpose
Improve a README for clarity and completeness.
Inputs to request
- Current README content.
- Setup prerequisites and runtime versions.
- Common failure modes or FAQs.
Workflow
- Ensure install, run, and test steps are present and ordered.
- Add required environment variables and configuration notes.
- Clarify expected outputs and common troubleshooting tips.
Output
- Revised README section suggestions.
- Checklist of missing items.
Quality bar
- Keep instructions concise and copy-pasteable.
- Surface the most common pitfalls early.
Signals
- GitHub stars
- 144
- Forks
- 30
- Last commit
- Jul 2026
Advanced
- Catalog kind
- skill
- Gateway key
readme-polish- Source
- github.com/proflead/codex-skills-library