README Discipline

Kodeforankrede README-er: hver påstand spores til file:line, hver kommando er verifisert til å kjøre.

av SkillProof · Skillproofdev/readme-discipline

Bestått ★ 8.8/10

README Discipline — Kodeforankrede README-er: hver påstand spores til file:line, hver kommando er verifisert til å kjøre.

Hva den gjør

Tvinger README-generering og -revisjoner til å spore hver påstand til kilden før den kan skrives — funksjoner må finnes i koden, kommandoer må kopieres fra ekte manifester og kjøres, og en kildebelagt Limitations-seksjon er obligatorisk. Benchmarket mot baseline-agenter på 3 ekte OSS-repoer med en klar seier på fullstendighet og blind preferanse, selv om marginen for redusert oppdiktning er smal og evalueringen brukte kun én vurderer.

Testrapport

Vår egen skill — testet under samme protokoll, avslørt. Benken målte 3 fastfrosne OSS-repoer, baseline mot skill-agent: skillen traff 18/18 på seksjonsfullstendighet mot 14/18, ble foretrukket 3/3 med tillit 4,67 mot 3,67, og hadde færre oppdiktede påstander (1 mot 2, en smal margin siden begge baselinene lånte korrekt innhold fra eksisterende dokumentasjon). Forbehold oppgitt i verdicten: kun én ekspertvurderer (ikke panelet med ≥3 utviklere protokollen krever), N=3, og skillen logget sin egen oppdiktning (en sammenblanding av HTTP 400/500) i stedet for å skjule den. Protokolltesten avdekket reelle problemer i våre egne repoer (døde benchmark-lenker, streng YAML-frontmatter) — fikset og reverifisert samme dag.

Testet på: 2026-07-11 · Claude Code 2.x (agent harness)

Installer

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

Kommandoer og eksempelprompter

  • /readme-disciplineKodeforankrede README-er: hver påstand spores til file:line, hver kommando er verifisert til å kjøre.

Skills utløses av vanlige forespørsler — ingen kommandoer å huske. Etter installasjonen aktiverer prompter som disse skillen (på engelsk):

  • 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