documentation-generation-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ć. Umiejętność wymaga dostępu do plików kodu, konfiguracji i komentarzy, aby móc z nich wyodrębnić informacje.

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

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

4. Wygeneruj dokumentację z konsekwentną terminologią i strukturą. Upewnij się, że wszystkie dokumenty używają jednolitych konwencji nazewnictwa i formatowania.

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

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