README Doctor

Rubrica README in 9 punti con lista di priorità P0/P1/P2, citata con evidenza e consapevole di categoria/pubblico.

di livlign · livlign/claude-skills

Richiede configurazione ★ 8.4/10

README Doctor — Rubrica README in 9 punti con lista di priorità P0/P1/P2, citata con evidenza e consapevole di categoria/pubblico.

Cosa fa

Revisiona un README rispetto a una rubrica di 9 criteri (presenza dell'eroe, lunghezza installazione-primo-successo, la frase 'cos'è questo', corrispondenza gergo-pubblico, scansionabilità, segnali di deriva come versioni obsolete e proliferazione di badge, superficie di contributo) pesata per categoria e pubblico del repository inferiti, quindi produce una lista di priorità con evidenza citata per riga. Si attiva su richieste di revisione, controllo o diagnosi del perché un README non funziona; esplicitamente non riscrive prosa o fa linting della sintassi markdown.

Rapporto di test

La sezione 1.1 ('modalità operativa') e il passaggio di apertura PR nella Fase 4 dicono entrambi 'uguale a repo-visuals' senza definire le modalità inline — repo-visuals vive in un plugin separato (plugins/repo-visuals) non incluso con readme-doctor, quindi un'installazione verbatim manca di quel pezzo; la rubrica di audit principale in 9 punti è completamente autonoma e ha prodotto una lista di priorità nitida, citata con evidenza, su un README di prova.

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

Installazione

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

Comandi e prompt di esempio

  • /readme-doctorRubrica README in 9 punti con lista di priorità P0/P1/P2, citata con evidenza e consapevole di categoria/pubblico.

Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):

  • 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