Automatyczne generowanie dokumentacji z AI
Documently.io umożliwia automatyczne generowanie dokumentacji przy pomocy sztucznej inteligencji na podstawie tzw. tranzycji.
Czym są tranzycje?
Tranzycje to krótkie opisy (notatki/rejestry), które podsumowują funkcjonalność lub fragment działania danego systemu/opcji.
Przykład:
"Użytkownicy mogą samodzielnie resetować hasło poprzez stronę logowania."
Zbiór wprowadzonych lub zaktualizowanych tranzycji stanowi wejście dla AI, które na tej podstawie wygeneruje treść dokumentacji.
Jak korzystać z AI?
- Wprowadź lub edytuj tranzycje opisujące funkcjonalność.
- Kliknij przycisk „Wygeneruj z AI”.
- Poczekaj na stworzenie przez system treści odpowiadających wprowadzonym opisom.
- Zmiany pojawią się na nowej gałęzi podlegającej standardowej procedurze przeglądania i publikacji (pull → merge do głównej gałęzi).
Zalety AI w procesie tworzenia dokumentacji
-
Szybkie opracowanie podstawowych sekcji dokumentacji
-
Jednolity, spójny język techniczny
-
Oszczędność czasu i łatwiejsze rozpoczęcie projektu dokumentacyjnego
Wygenerowane przez AI treści podlegają dokładnie tym samym mechanizmom wersjonowania oraz akceptacji jak treści pisane manualnie przez zespół.