readme-optimization

Audits and rewrites repository READMEs against verified claims and a scored rubric.

2|Updated Sep 6, 2026
One-click install
npx skills add https://github.com/samber/developer-relations-skills --skill readme-optimization-samber
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-optimization
Source: https://github.com/samber/developer-relations-skills/tree/main/skills/readme-optimization
Command: npx skills add https://github.com/samber/developer-relations-skills --skill readme-optimization-samber

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Developers decide whether to try a project within seconds of landing on its README, yet most READMEs bury the install path, skip differentiation, and carry unverifiable claims. This Skill diagnoses the existing README against evidence, then rewrites it so a stranger can evaluate the project quickly and accurately. ## Core Features & Use Cases - Evidence-based audit: Runs a mechanical script plus a five-blocking-check, eight-scored-check scorecard, with every verdict backed by a line number, quoted sentence, or executed command. - Claim verification: Checks every command, flag, default, and behavioural assertion against the actual source code, and runs the documented install from a clean state. - Structured rewrite: Orders sections by cognitive funneling, calibrates badges using published research, fixes repository furniture, and adds enterprise trust signals only when the audience requires them. - Use Case: Before an open-source launch, ask for a README audit; receive a scorecard showing a broken install path and missing differentiation, then a section-by-section rewrite approved incrementally. ## Quick Start Ask the assistant to audit the README of your repository and produce the scorecard before rewriting anything.

Frequently Asked Questions about readme-optimization

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit my GitHub README before a launch?

Run the readme-audit script for mechanical facts like section count, badge count, and broken links, then score the file against five blocking checks and eight scored checks. Every verdict needs evidence such as a line number or a command you actually ran.

What should a good README structure look like?

Order sections by cognitive funneling: identity and one-liner first, then differentiation, usage, install, and detail, with a non-permissive licence moved near the top. Half of sampled READMEs sit between 5 and 12 sections with a median of 7.

How many badges should a README have?

Keep four or fewer as a working default, retaining only assessment signals backed by third-party checks like CI status, coverage, and published version. Research on 294,941 npm packages found badge adoption does not raise popularity and excessive badges correlate with decreased popularity.

Does this work for package registry pages like npm or PyPI?

Yes, the audit treats the registry render as a separate target because registries render the README on their own domain, breaking relative links and stripping raw HTML. Convert relative paths to absolute URLs at publish time.

When should I not rewrite my README?

Skip the rewrite when traffic data shows few visitors in the first place, since that is a distribution problem rather than a prose problem. Route to launch or distribution work instead, and still fix the repository description, topics, and social preview.