documentation-generation-doc-generate
Generuj dokumentację API, przewodniki i schematy bezpośrednio z kodu
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność automatycznego tworzenia dokumentacji technicznej z analizy kodu. Generujesz dokumentację API, diagramy architektury, przewodniki użytkownika i referencje techniczne na podstawie istniejącego kodu źródłowego. Narzędzie wyodrębnia informacje z kodu, komentarzy i konfiguracji, a następnie tworzy spójną, utrzymywaną dokumentację zgodną z najlepszymi praktykami branżowymi. Idealne do automatyzacji procesów dokumentacji i standaryzacji dokumentów w całym projekcie.
Jak używać
Przygotuj dostęp do kodu źródłowego projektu, który chcesz udokumentować. Umiejętność wymaga dostępu do plików kodu, konfiguracji i komentarzy, aby móc z nich wyodrębnić informacje.
Zdefiniuj typy dokumentacji, które potrzebujesz wygenerować (dokumentacja API, diagramy architektury, przewodniki użytkownika lub referencje techniczne) oraz wskaż docelową grupę odbiorców dla każdego typu dokumentu.
Wyodrębnij informacje z kodu źródłowego, konfiguracji i istniejących komentarzy. Umiejętność przeanalizuje strukturę projektu i zbierze dane niezbędne do tworzenia dokumentacji.
Wygeneruj dokumentację z konsekwentną terminologią i strukturą. Upewnij się, że wszystkie dokumenty używają jednolitych konwencji nazewnictwa i formatowania.
Skonfiguruj automatyzację procesów dokumentacji, takie jak linting czy integracja z CI/CD, aby dokumentacja pozostawała zsynchronizowana z kodem. Zweryfikuj dokładność wygenerowanej dokumentacji i zidentyfikuj luki wymagające uzupełnienia.
Przejrzyj plik resources/implementation-playbook.md w repozytorium umiejętności, jeśli potrzebujesz szczegółowych przykładów, szablonów lub dodatkowych wskazówek dotyczących implementacji.