docs-writer
Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Always use this skill when the task involves writing, reviewing, or editing files in the /docs directory or any .md files in the repository.
How to use
Aktywuj umiejętność
docs-writerw swoim projekcie Gemini CLI, aby automatycznie włączała się przy pracach nad dokumentacją.Kiedy potrzebujesz napisać, zedytować lub przejrzeć plik w katalogu
/docslub dowolny plik.mdw repozytorium, przekaż zadanie tej umiejętności — będzie stosować standardy dokumentacji projektowej.Umiejętność będzie adresować czytelnika jako "ty", używać strony czynnej i czasu teraźniejszego (np. "API zwraca..."), aby tekst był jasny i bezpośredni.
Upewnij się, że zawartość unika żargonu, skrótów łacińskich (zamiast "np." używaj "na przykład"), oraz zachowuje precyzję w wymaganiach — rozróżniając między "musi" a "zalecamy".
Przejrzyj wygenerowaną dokumentację pod kątem zgodności z wytycznymi: ton profesjonalny ale przyjazny, słownictwo proste, przykłady z sensownymi nazwami, oraz formatowanie z przecinkami seryjnymi.
Jeśli dokumentacja dotyczy kodu, upewnij się, że odzwierciedla aktualny stan bazy kodu projektu i jest zgodna z procesem z pliku
CONTRIBUTING.md.