README Doctor

9-punkters README-rubrik med P0/P1/P2 punch-lista, bevis-citerad och kategori/målgruppsmedveten.

av livlign · livlign/claude-skills

Fungerar med konfiguration ★ 8.4/10

README Doctor — 9-punkters README-rubrik med P0/P1/P2 punch-lista, bevis-citerad och kategori/målgruppsmedveten.

Vad den gör

Granskar en README mot en 9-kriteriers rubrik (hjälte-närvaro, installation-till-första-framgång-längd, meningen 'vad är detta', målgrupps-jargong-matchning, skannbarhet, drift-signaler som inaktuella versioner och badge-svall, bidragsyta) viktad efter härledd repokategori och målgrupp, och matar sedan ut en prioriterad punch-lista med rad-citerade bevis. Triggers vid förfrågningar om att granska, recensera eller diagnostisera varför en README inte landar; skriver uttryckligen inte om prosa eller lintar markdown-syntax.

Testrapport

Sektion 1.1 ('operating mode') och PR-öppningssteget i Fas 4 säger båda 'same as repo-visuals' utan att definiera lägena inline — repo-visuals lever i ett separat plugin (plugins/repo-visuals) som inte är bundlat med readme-doctor, så en ordagrann installation saknar den delen; själva kärnan i 9-punkters granskningsrubriken är helt fristående och producerade en skarp, bevis-citerad, prioriterad punch-lista på en test-README.

Testad: 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

Kommandon och exempelprompter

  • /readme-doctor9-punkters README-rubrik med P0/P1/P2 punch-lista, bevis-citerad och kategori/målgruppsmedveten.

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

  • 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