Toolverse
Wszystkie skille

docs-writer

autor: google-gemini

Asystent do pisania i edycji dokumentacji technicznej w projektach

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Data Science
Wyświetlenia
19

O skillu

Umiejętność wspierająca pisanie, recenzję i edycję plików dokumentacji w katalogach /docs i plikach .md. Zapewnia spójność, jasność i zgodność z wytycznymi projektowymi. Adopts profesjonalny, przyjazny ton z aktywną stronę bierną i teraźniejszym czasem. Pomaga unikać żargonu, niejasności i błędów gramatycznych zgodnie ze standardami dokumentacji technicznej.

Jak używać

  1. Aktywuj umiejętność docs-writer w swoim projekcie Gemini CLI, aby automatycznie włączała się przy pracach nad dokumentacją.

  2. Kiedy potrzebujesz napisać, zedytować lub przejrzeć plik w katalogu /docs lub dowolny plik .md w repozytorium, przekaż zadanie tej umiejętności — będzie stosować standardy dokumentacji projektowej.

  3. 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.

  4. 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".

  5. 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.

  6. Jeśli dokumentacja dotyczy kodu, upewnij się, że odzwierciedla aktualny stan bazy kodu projektu i jest zgodna z procesem z pliku CONTRIBUTING.md.

Podobne skille