D
docs-review
Automatyczna kontrola dokumentacji pod kątem spójności stylu i czytelności
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do przeglądu zmian w dokumentacji markdown. Sprawdza pull requesty i pliki pod kątem zgodności z wytycznymi stylu Metabase — ton głosu, strukturę tekstu, jasność komunikacji. Wykrywa formalne sformułowania, niejasne nagłówki, zaburzoną logikę narracyjną i inne problemy czytelności. Pracuje w trybie recenzji PR na GitHubie lub jako lista problemów w rozmowie.
Jak używać
- Zainstaluj skill docs-review w swoim środowisku Claude/Codex, upewniając się, że masz dostęp do narzędzi Read, Grep, Bash i Glob. 2. Przygotuj materiał do przeglądu — pull request z dokumentacją markdown, pojedynczy plik lub diff zmian. 3. Uruchom skill, podając ścieżkę do pliku lub wskazując PR do przeglądu. Skill automatycznie wykryje tryb pracy: jeśli dostępne jest narzędzie GitHub do tworzenia recenzji, użyje trybu PR; w przeciwnym razie wyświetli wyniki w rozmowie. 4. Skill przeanalizuje tekst pod kątem naruszeń wytycznych stylu — formalnego języka zamiast naturalnego, użycia słowa "użytkownicy" zamiast "ludzie", zbyt entuzjastycznego tonu, niejasnych nagłówków, zaburzonych instrukcji. 5. Przejrzy strukturę i logikę — czy ważne informacje nie są ukryte, czy tekst nie jest zbyt rozwlekły, czy każdy akapit ma wyraźny cel. 6. Otrzymasz numerowaną listę znalezionych problemów z wyjaśnieniami — każdy punkt zawiera konkretne wskazanie, co zmienić i dlaczego, aby dokumentacja była bardziej czytelna i spójna ze standardami Metabase.