D
docs-write
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).
How to use
- 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.