Toolverse
Wszystkie skille

create-documentation

autor: LibPDF-js

Generuj profesjonalną dokumentację markdown dla swoich modułów i funkcji

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Backend

O skillu

Skill do automatycznego tworzenia i aktualizacji dokumentacji markdown dla bibliotek i modułów. Analizuje kod źródłowy, sprawdza istniejące dokumenty i generuje kompletne opisy API, przewodniki funkcji oraz dokumentację koncepcyjną w formacie MDX. Idealny dla zespołów utrzymujących projekty open-source z wymagającą dokumentacją techniczną.

Jak używać

  1. Określ zakres dokumentacji — wskaż skill'owi, który moduł, funkcję lub plik wymaga dokumentacji. Jeśli nie jesteś pewien, skill zapyta o szczegóły.

  2. Przygotuj kontekst — skill przeanalizuje kod źródłowy modułu, aby zrozumieć publiczne API, typy danych i zachowanie funkcji.

  3. Sprawdź istniejące dokumenty — skill przejrzy folder content/docs/ w twoim projekcie, aby znaleźć powiązane dokumenty i uniknąć duplikacji.

  4. Wybierz typ dokumentacji — zdecyduj, czy tworzysz referencję API (dla klas i metod), przewodnik funkcji (dla feature'ów), dokumentację koncepcyjną czy przewodnik migracji.

  5. Wygeneruj dokumentację — skill utworzy lub zaktualizuje plik MDX w odpowiednim katalogu (api/, guides/, concepts/ lub advanced/), zgodnie ze strukturą projektu Fumadocs.

  6. Przejrzyj i dostosuj — sprawdź wygenerowaną dokumentację pod kątem tonu, formatowania i zgodności z wytycznymi projektu zawartymi w WRITING_STYLE.md.

Podobne skille