D
docs-review
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
How to use
- 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.