README Discipline

READMEs podložené kódem: každé tvrzení dohledatelné na file:line, každý příkaz ověřeně funkční.

od SkillProof · Skillproofdev/readme-discipline

Otestováno · Funguje ★ 8.8/10

README Discipline — READMEs podložené kódem: každé tvrzení dohledatelné na file:line, každý příkaz ověřeně funkční.

Co umí

Vynucuje, aby generování i revize READMU dohledaly zdroj každého tvrzení dřív, než se napíše — funkce musí být opravdu v kódu, příkazy musí být opsané z reálných manifestů a odzkoušené a sekce Omezení s uvedenými zdroji je povinná. Testováno proti základním agentům na 3 reálných OSS repozitářích s jasnou výhrou v úplnosti i hodnocení naslepo, byť rozdíl v omezení vymyšlených tvrzení je úzký a hodnocení prováděl jediný hodnotitel.

Testovací report

Náš vlastní skill — testovaný podle stejného protokolu, otevřeně přiznáno. Benchmark proměřil 3 zamrazené OSS repozitáře, základní agent vs. agent se skillem: skill dosáhl úplnosti sekcí 18/18 oproti 14/18, byl preferovaný 3/3 s důvěryhodností 4,67 vs. 3,67 a měl méně vymyšlených tvrzení (1 vs. 2 — úzký rozdíl, protože obě základní varianty přebíraly přesný obsah z existující dokumentace). Ve verdiktu jsou uvedená i omezení: jediný odborný hodnotitel (ne panel alespoň 3 vývojářů, který protokol vyžaduje), N=3, a skill si svou vlastní chybu (záměnu HTTP 400/500) sám zaznamenal místo aby ji skrýval. Test protokolu odhalil reálné problémy v našich vlastních repozitářích (mrtvé odkazy na benchmarky, přísný YAML frontmatter) — opraveno a znovu ověřeno tentýž den.

Testováno: 2026-07-11 · Claude Code 2.x (agent harness)

Instalace

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

Příkazy a ukázkové prompty

  • /readme-disciplineREADMEs podložené kódem: každé tvrzení dohledatelné na file:line, každý příkaz ověřeně funkční.

Skilly se spouštějí běžnými požadavky — žádné příkazy k zapamatování. Po instalaci ho aktivují prompty jako tyto (anglicky):

  • 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