docs-write

Umiejętność do tworzenia i edytowania dokumentacji markdown i MDX zgodnie z wytycznymi stylu Metabase. Narzędzie prowadzi Cię przez proces pisania: od zdefiniowania odbiorcy i jego potrzeb, przez drafting i edycję, aż po formatowanie. Zawiera konkretne wzorce dla instrukcji, nagłówków i linków, a także przypomina o weryfikacji przykładów kodu i zastosowaniu prettier do spójnego formatowania.

1. Zainstaluj umiejętność w swoim środowisku Claude/Codex, wskazując repozytorium Metabase i ścieżkę .claude/skills/docs-write. 2. Przygotuj plik dokumentacji (markdown lub MDX), który chcesz utworzyć lub edytować. 3. Zanim zaczniesz pisać, zdefiniuj odbiorców – określ, dla kogo piszesz i jaki poziom skomplikowania jest odpowiedni. 4. Napisz pierwszą wersję, prowadząc czytnika do odpowiedzi jak najszybciej; zacznij od czynności, potem wyjaśnij dlaczego. 5. Przeczytaj tekst na głos – jeśli brzmi zbyt formalnie, uprość go; usuń wszystko, co nie pomaga bezpośrednio czytelnikowi. 6. Sprawdź, czy każdy akapit ma jeden jasny cel, a przykłady kodu rzeczywiście działają. 7. Sformatuj plik poleceniem yarn prettier --write, aby zapewnić spójność z resztą dokumentacji Metabase.