Docs Guard
Sprawdza dokumentację względem źródła: halucynowane symbole, uszkodzone przykłady, niemożliwe do zweryfikowania twierdzenia
Testowano · Działa
Co robi ten skill
Docs Guard to umiejętność przeglądu dokumentacji deweloperskiej — README, referencji API, docstringów, PHPDoc/JSDoc, changelogów, tutoriali. Zamienia dokument w listę twierdzeń i weryfikuje każdy symbol, sygnaturę, flagę, punkt końcowy, klucz konfiguracyjny i przykład kodu względem rzeczywistego źródła, a następnie raportuje wyniki jako Twierdzenie / Rzeczywistość / Naprawa z dowodami file:line i werdyktem publikacji. Uruchamia się, gdy prosisz o przegląd, audyt lub weryfikację dokumentacji, gdy agent właśnie napisał lub edytował dokumentację, lub przed opublikowaniem README lub referencji API.
Raport z testu
INSTALACJA: frontmatter jest prawidłowym YAML z name + długim, dobrze zdefiniowanym opisem; wszystkie sześć plików referencyjnych (references/verification.md, code-samples.md, docstrings.md, review-checklist.md, sources.md, agents/openai.yaml) zwróciło HTTP 200 przy pobieraniu surowym; brak skryptów, brak curl|sh, brak base64, brak dostępu do sekretów, brak tekstu iniekcji — umiejętność to czysty markdown. TRIGGER, 5/5 poprawnie: POWINIEN zadziałać — "Przejrzyj ten README względem kodu, zanim go opublikuję, czy coś w nim jest źle?", "Agent właśnie przepisał nasze referencje API i docstringi, sprawdź je pod kątem dryfu, zanim scalę", "Napisz README dla tego pakietu" (opis wymienia "write a README" i definiuje tryb na żywo); NIE POWINIEN zadziałać — "Przepisz tekst hero na naszej stronie głównej, aby był bardziej przekonujący" (tekst marketingowy znajduje się na liście jawnie ZABRONIONYCH), "Przejrzyj obsługę błędów Pythona w tym PR" (przegląd kodu produkcyjnego, przekierowany do clean-code-guard). WYNIK: napisałem 24-liniowy retry.py plus celowo zmieniony README, stworzyłem bazowy przegląd bez załadowanej umiejętności (8 ustaleń, lista prozy, brak odniesień do linii), a następnie przegląd w trybie zgodnym z umiejętnością; wersja umiejętności znalazła 11 ustaleń, w tym trzy, które wersja bazowa pominęła (brak dokumentacji ścieżki awarii, więc RetryError nigdy nie jest wspomniany, brak polityki wersji/kompatybilności, niezdefiniowane `fetch` w przykładzie naruszające samodzielność), cytowała file:line po obu stronach dokumentacji i kodu, a — zgodnie z "prefer executable checks" z verification.md — faktycznie uruchomiłem przykład i otrzymałem `TypeError: retry() got an unexpected keyword argument 'max_retries'` i potwierdziłem `e.__cause__ is None`, zamieniając dwie miękkie asercje w twarde dowody. Koszt to długość (~3x wersja bazowa) i samodzielnie oceniona liczba "23 sprawdzonych twierdzeń"; główne ustalenia dotyczące dryfu mocno się pokrywały, więc zysk to rygor i dowody, a nie nowa klasa błędów. DOKUMENTACJA: twierdzenia README dotyczące poszczególnych umiejętności (progressive-disclosure references, @param matching, "blazingly fast leaves the building") wszystkie odpowiadają rzeczywistym zasadom w treści — Reguła 7 dosłownie wymienia tę frazę, a docstrings.md obejmuje dokładność tagów; dane badawcze są cytowane z adresami URL w sources.md, którego nie otwierałem.
Testowano: 2026-07-21 · Claude Code 2.x (agent harness)
Instalacja
npx skills add amElnagdy/guard-skills --skill docs-guard # add --global for a global install, --agent claude-code to pin the agent # manual alternative: git clone https://github.com/amElnagdy/guard-skills /tmp/guard-skills mkdir -p ~/.claude/skills cp -r /tmp/guard-skills/skills/docs-guard ~/.claude/skills/docs-guard # then: "Use docs-guard on this README before we ship it."
Komendy i przykładowe prompty
/docs-guardSprawdza dokumentację względem źródła: halucynowane symbole, uszkodzone przykłady, niemożliwe do zweryfikowania twierdzenia
Skille uruchamiają się na zwykłe polecenia — bez komend do zapamiętania. Po instalacji aktywują go prompty takie jak te (po angielsku):
Is this documentation accurate to the codeReview the docs before I publish this updateCheck this README for stale information