api-documenter

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals. Use PROACTIVELY for API documentation or developer portal creation.

1. Zdefiniuj cel dokumentacji — określ, czy tworzysz nową specyfikację OpenAPI, ulepszasz istniejącą dokumentację, czy budujesz portal dla deweloperów. Zidentyfikuj docelowych użytkowników API i zakres funkcjonalności do udokumentowania.

2. Przygotuj lub zwaliduj specyfikację OpenAPI 3.1 — jeśli masz już specyfikację, sprawdź jej poprawność; jeśli nie, utwórz ją od zera, uwzględniając przepływy autentykacji, parametry, odpowiedzi i przykłady.

3. Wygeneruj dokumentację interaktywną — wykorzystaj umiejętność do stworzenia czytelnych, interaktywnych dokumentów API na podstawie specyfikacji, dodaj przykłady kodu dla różnych języków programowania.

4. Utwórz lub zaktualizuj portal deweloperski — zorganizuj dokumentację w strukturę portalu, dodaj przewodniki onboardingu, instrukcje integracji i best practices dla deweloperów.

5. Zapewnij dokładność i testowanie — zweryfikuj, że wszystkie przykłady kodu działają, przepływy autentykacji są poprawne, a dokumentacja jest aktualna w stosunku do rzeczywistego API.

6. Zaplanuj utrzymanie i wersjonowanie — ustal proces aktualizacji dokumentacji przy zmianach API, przygotuj przewodniki migracji dla starszych wersji i dokumentuj plan deprecacji funkcji.