README Discipline

Kodförankrade READMEs: varje påstående spårat till fil:rad, varje kommando verifierat att köra.

av SkillProof · Skillproofdev/readme-discipline

Testad · Fungerar ★ 8.8/10

README Discipline — Kodförankrade READMEs: varje påstående spårat till fil:rad, varje kommando verifierat att köra.

Vad den gör

Tvingar README-generering och granskningar att spåra varje påstående till källan innan det får skrivas — funktioner måste hittas i koden, kommandon måste kopieras från riktiga manifest och köras, och ett källbelagt Begränsningar-avsnitt är obligatoriskt. Benchmarkad mot baslinjeagenter på 3 riktiga OSS-repos med en tydlig vinst på fullständighet och blind preferens, även om marginalen för minskade påhitt är smal och utvärderingen gjordes av en enda bedömare.

Testrapport

Vår egen skill — testad enligt samma protokoll, öppet redovisat. Benchmarken mätte 3 frysta OSS-repos, baslinje mot skill-agent: skillen nådde 18/18 i avsnittsfullständighet mot 14/18, föredrogs 3/3 med förtroende 4,67 mot 3,67, och hade färre påhittade påståenden (1 mot 2 — en smal marginal eftersom båda baslinjerna lånade korrekt innehåll från befintlig dokumentation). Brasklappar redovisade i verdicten: en enda expertbedömare (inte den panel på minst 3 utvecklare som protokollet kräver), N=3, och skillen loggade sitt eget påhitt (en HTTP 400/500-sammanblandning) i stället för att dölja det. Protokolltestet hittade verkliga problem i våra egna repos (döda benchmark-länkar, sträng YAML-frontmatter) — åtgärdat och verifierat på nytt samma dag.

Testad: 2026-07-11 · Claude Code 2.x (agent harness)

Installation

git clone https://github.com/Skillproofdev/readme-discipline ~/.claude/skills/readme-discipline

Kommandon och exempelprompter

  • /readme-disciplineKodförankrade READMEs: varje påstående spårat till fil:rad, varje kommando verifierat att köra.

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

  • Write a README for this repo
  • Can you review our README.md and flag anything that's inaccurate or outdated?
  • I'm scaffolding a new npm package — generate the initial README along with package.json