README Doctor

Rubrique README en 9 points avec liste de tâches P0/P1/P2, preuves citées et consciente de la catégorie/audience.

par livlign · livlign/claude-skills

Fonctionne avec configuration ★ 8.4/10

README Doctor — Rubrique README en 9 points avec liste de tâches P0/P1/P2, preuves citées et consciente de la catégorie/audience.

Ce que fait

Audite un README par rapport à une rubrique en 9 critères (présence du héros, longueur de l'installation à la première réussite, la phrase 'qu'est-ce que c'est', correspondance jargon/audience, scannabilité, signaux de dérive comme les versions obsolètes et l'étalement des badges, surface de contribution) pondérée par la catégorie et l'audience du dépôt inférées, puis génère une liste de tâches priorisée avec des preuves citées par ligne. Se déclenche sur les demandes d'audit, de revue ou de diagnostic de pourquoi un README ne fonctionne pas; ne réécrit explicitement pas la prose ni ne vérifie la syntaxe markdown.

Rapport de test

La section 1.1 ('operating mode') et l'étape d'ouverture de PR dans la phase 4 disent toutes deux 'same as repo-visuals' sans définir les modes en ligne — repo-visuals vit dans un plugin séparé (plugins/repo-visuals) non groupé avec readme-doctor, donc une installation verbatim manque cette pièce; la rubrique d'audit principale en 9 points est entièrement autonome et a produit une liste de tâches nette, priorisée et citée par preuves sur un README de test.

Testé le: 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

Commandes et exemples de prompts

  • /readme-doctorRubrique README en 9 points avec liste de tâches P0/P1/P2, preuves citées et consciente de la catégorie/audience.

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

  • 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