README Doctor

9-punkts README-rubrik med P0/P1/P2 punch list, bevis-citeret og kategori/målgruppe-bevidst.

Af livlign · livlign/claude-skills

Virker med opsætning ★ 8.4/10

README Doctor — 9-punkts README-rubrik med P0/P1/P2 punch list, bevis-citeret og kategori/målgruppe-bevidst.

Hvad det gør

Auditerer en README mod en 9-kriterie rubrik (hero presence, install-to-first-success length, 'what is this' sentence, audience-jargon match, scannability, drift signals som stale versions og badge sprawl, contribution surface) vægtet efter infereret repo-kategori og målgruppe, og outputter derefter en prioriteret punch list med linje-citeret bevis. Triggere på anmodninger om at auditere, gennemgå eller diagnosticere, hvorfor en README ikke lander; omskriver eksplicit ikke prosa eller linter markdown-syntaks.

Testrapport

Sektion 1.1 ('operating mode') og PR-åbningssteppet i Fase 4 siger begge 'same as repo-visuals' uden at definere modes inline — repo-visuals lever i et separat plugin (plugins/repo-visuals), der ikke er bundlet med readme-doctor, så en verbatim installation mangler den del; selve kernen 9-punkts audit-rubrikken er fuldt selvstændig og producerede en skarp, bevis-citeret, prioriteret punch list på en test README.

Testet: 2026-07-15 · Claude Code 2.x (agent harness)

Installation

git clone https://github.com/livlign/claude-skills
cd claude-skills
mkdir -p ~/.claude/skills
cp -r plugins/repo-doctor/skills/readme-doctor ~/.claude/skills/readme-doctor

Kommandoer og eksempelprompter

  • /readme-doctor9-punkts README-rubrik med P0/P1/P2 punch list, bevis-citeret og kategori/målgruppe-bevidst.

Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen aktiverer prompter som disse skillen (på engelsk):

  • why isn't my README landing with new visitors, what's missing
  • audit this README and give me a prioritized list of fixes
  • does my project's README explain what it does fast enough