README Discipline
README oparte na realnym kodzie: każde stwierdzenie powiązane z file:line, każda komenda sprawdzona, że działa.
Testowano · Działa
Co robi ten skill
Wymusza, żeby generowanie i audyt README najpierw powiązały każde stwierdzenie ze źródłem, zanim trafi ono do dokumentu — funkcje muszą być odnalezione w kodzie, komendy muszą być skopiowane z realnych plików manifestu i faktycznie uruchomione, a sekcja Limitations z odniesieniami do źródeł jest obowiązkowa. Zbenchmarkowane względem agentów bazowych na 3 realnych repozytoriach open source, z wyraźną wygraną pod względem kompletności i preferencji w ślepym teście, choć różnica w redukcji zmyśleń jest niewielka, a ocenę robiła tylko jedna osoba.
Raport z testu
Nasz własny skill — testowany według tego samego protokołu, jawnie to zaznaczamy. Benchmark objął 3 zamrożone repozytoria open source, agent bazowy vs agent ze skillem: skill osiągnął 18/18 kompletności sekcji wobec 14/18, był preferowany 3/3 razy przy zaufaniu 4,67 vs 3,67, i miał mniej zmyślonych stwierdzeń (1 vs 2 — niewielka różnica, bo oba warianty bazowe zapożyczały trafne treści z istniejącej dokumentacji). Zastrzeżenia ujawnione w werdykcie: jeden ekspercki oceniający zamiast panelu co najmniej 3 deweloperów wymaganego przez protokół, N=3, a skill sam odnotował własne zmyślenie (pomyloną parę HTTP 400/500), zamiast je ukrywać. Test protokołu wykrył realne problemy w naszych własnych repozytoriach (martwe linki do benchmarków, zbyt rygorystyczny YAML frontmatter) — naprawione i ponownie zweryfikowane tego samego dnia.
Testowano: 2026-07-11 · Claude Code 2.x (agent harness)
Instalacja
git clone https://github.com/Skillproofdev/readme-discipline ~/.claude/skills/readme-discipline
Komendy i przykładowe prompty
/readme-disciplineREADME oparte na realnym kodzie: każde stwierdzenie powiązane z file:line, każda komenda sprawdzona, że działa.
Skille uruchamiają się na zwykłe polecenia — bez komend do zapamiętania. Po instalacji aktywują go prompty takie jak te (po angielsku):
Write a README for this repoCan 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