code-documentation-doc-generate

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

1. Przygotuj dostęp do kodu źródłowego projektu, który chcesz udokumentować. Upewnij się, że masz dostęp do wszystkich plików, konfiguracji i komentarzy w kodzie, które będą podstawą do generowania dokumentacji.

2. Zdefiniuj typy dokumentacji, które potrzebujesz — czy będą to dokumentacja API, diagramy architektury, przewodniki użytkownika czy referencje techniczne. Określ również docelową grupę odbiorców dla każdego typu dokumentacji.

3. Uruchom umiejętność, podając kod źródłowy i wymagania dotyczące dokumentacji. Umiejętność przeanalizuje kod, wyodrębni istotne informacje i wygeneruje dokumentację zgodnie z branżowymi najlepszymi praktykami.

4. Przejrzyj wygenerowaną dokumentację pod kątem dokładności i spójności terminologii. Sprawdź, czy wszystkie API, komponenty i funkcjonalności są prawidłowo opisane.

5. Skonfiguruj automatyzację dokumentacji, na przykład poprzez linting i integrację z CI/CD, aby dokumentacja była aktualizowana razem ze zmianami w kodzie.

6. Wdrażaj wygenerowaną dokumentację w swoim projekcie, upewniając się, że pozostaje zsynchronizowana ze źródłem kodu w przyszłości.