Jak automatycznie dokumentować procesy oprogramowania

Ręczne pisanie dokumentacji procesów to jedno z tych zadań, o których zespoły wiedzą, że muszą je wykonać, ale rzadko mają na to czas. Wymaga to skupienia, czasu i wystarczającej znajomości procesu, aby opisać go dokładnie. Zanim ktoś usiądzie do napisania SOP dla przepływu pracy, który wykonuje codziennie, myślami jest już gdzie indziej.

Alternatywa: nagraj siebie podczas wykonywania procesu i pozwól AI przekształcić nagranie w dokumentację. Oto jak to skonfigurować.

Jak wygląda automatyczna dokumentacja procesów#

Automatyczna dokumentacja procesów nie oznacza, że AI zgaduje, na czym polega Twój proces. Oznacza to, że AI obserwuje, co faktycznie robisz na ekranie i dokumentuje to precyzyjnie.

Wykonujesz proces w swoim produkcie, CRM-ie, narzędziu wewnętrznym lub dowolnym oprogramowaniu działającym na komputerze Mac lub Windows. Nagranie rejestruje każde kliknięcie, naciśnięcie klawisza i stan ekranu. AI analizuje te ustrukturyzowane dane i tworzy dokumentację, która dokładnie odzwierciedla to, co zrobiłeś, w poprawnej kolejności i z użyciem właściwej terminologii.

Wynik nie jest transkrypcją. To pisemny przewodnik krok po kroku z numerowanymi etapami, zrzutami ekranu umieszczonymi w odpowiednich miejscach, nagłówkami sekcji dla każdej fazy procesu oraz osadzonym filmem instruktażowym, który pokazuje proces w ruchu.

Na tym polega różnica między tym rozwiązaniem a narzędziami, których możesz już używać. Notion i Confluence to dobre miejsca do przechowywania dokumentacji, ale jej nie piszą. Loom rejestruje wideo, pozostawiając pisemny przewodnik Tobie. Narzędzie do dokumentacji procesów, które działa na podstawie nagrania, tworzy oba te elementy.

Krok po kroku: dokumentowanie procesu oprogramowania z Clevera#

Krok 1: Otwórz Clevera i rozpocznij nagrywanie Uruchom aplikację desktopową Clevera na systemie Mac (macOS 12.3 lub nowszym) lub Windows (10 Build 20348 lub nowszym). Kliknij nagrywaj przed rozpoczęciem procesu. Masz już nagranie procesu? Prześlij je zamiast tego.

Krok 2: Wykonaj proces w normalny sposób Przejdź przez przepływ pracy w normalnym tempie. Klikaj menu, wypełniaj pola, nawiguj między ekranami. Nie musisz zwalniać ani niczego wyjaśniać w trakcie. Clevera zarejestruje wszystko.

Krok 3: Zatrzymaj nagrywanie po zakończeniu procesu Kliknij stop. Clevera wyśle zarejestrowane dane, w tym interakcje z ekranem, ruchy myszy i kontekst aplikacji, do swojego potoku przetwarzania AI.

Krok 4: Przejrzyj dokumentację wygenerowaną przez AI W ciągu kilku minut Clevera wygeneruje dwa wyniki:

• Narracyjny film instruktażowy z lektorem wygenerowanym przez AI, zsynchronizowanym z każdym krokiem
• Ustrukturyzowany przewodnik pisemny z numerowanymi krokami, automatycznie wybranymi zrzutami ekranu i nagłówkami sekcji

Przejrzyj oba elementy w edytorze Clevera. Wideo odtwarza się w edytorze osi czasu. Artykuł otwiera się w edytorze blokowym przypominającym Notion.

Krok 5: Edytuj tam, gdzie to konieczne Wygenerowana dokumentacja jest zazwyczaj dokładna, ale warto ją przejrzeć. Dodaj notatkę o częstym błędzie w kroku 4. Zmień brzmienie nieco niejasnego kroku. Poproś AI o dodanie ostrzeżenia dla destrukcyjnej akcji. Te edycje zajmują minuty.

Krok 6: Opublikuj Opublikuj w swoim centrum pomocy Clevera, wyeksportuj do Markdown lub HTML, lub – w planie Pro i wyższych – opublikuj bezpośrednio do Notion, Confluence, GitHub, Help Scout Docs i innych platform. Wideo osadza się na górze artykułu.

Do jakich procesów oprogramowania sprawdza się to najlepiej#

Wielokrokowe przepływy pracy w produktach SaaS. Konfigurowanie integracji, ustawianie uprawnień użytkowników, tworzenie i publikowanie treści, generowanie raportów. Wszystko, co obejmuje sekwencję kroków w interfejsie użytkownika.

Procesy administracyjne i IT. Tworzenie kont użytkowników, konfigurowanie ustawień systemowych, wykonywanie zadań konserwacyjnych. Często są one niedostatecznie udokumentowane, ponieważ wykonuje się je tylko sporadycznie, co czyni je dokładnie takimi procesami, które najbardziej zyskują na dokumentacji.

Przepływy onboardingu dla klientów. Udokumentuj kroki, które nowy klient musi podjąć, aby czerpać wartość z Twojego produktu. Utrzymuj dokumentację w aktualności, nagrywając ją ponownie, gdy przepływ się zmieni.

Wewnętrzne procesy zespołowe. Przepływy pracy HR, zatwierdzenia finansowe, procesy sprzedażowe w CRM. Każdy proces oparty na oprogramowaniu, którego musi nauczyć się nowy członek zespołu.

Utrzymywanie automatycznej dokumentacji procesów w aktualności#

Największą zaletą dokumentacji opartej na nagraniach nie jest tylko początkowe tworzenie. Chodzi o to, jak łatwe staje się aktualizowanie.

W tradycyjnej dokumentacji aktualizacja oznacza otwarcie artykułu, znalezienie zmienionych kroków, ich przeredagowanie, wykonanie nowych zrzutów ekranu, zastąpienie starych i publikację. Z Clevera aktualizacja oznacza ponowne nagranie zmienionych kroków, co zajmuje kilka minut, wygenerowanie nowej dokumentacji i publikację.

Funkcja LiveSync w Clevera zajmuje się dystrybucją. Zaktualizowane filmy pojawiają się wszędzie tam, gdzie są osadzone, bez konieczności ręcznej wymiany plików. Jeśli na ekranie nic się nie zmieniło, np. w notatce o zasadach lub dodatkowym kontekście, możesz edytować narrację i tekst artykułu bez ponownego nagrywania.

Dzięki temu utrzymywanie SOP i przewodników procesowych w zgodzie z każdą aktualizacją produktu staje się realistyczne, a nie tylko w przypadku tych głównych.

Dlaczego nagrywanie wygrywa z pisaniem w dokumentacji procesów#

Pisanie procesu z pamięci jest wolniejsze i mniej dokładne niż jego nagrywanie. Zapomnisz o jakimś kroku. Pominiesz coś, co wydawało się oczywiste. Użyjesz nieco innej terminologii niż ta, która pojawia się na ekranie.

Nagrywanie rejestruje to, co faktycznie się dzieje. Automatyczna dokumentacja procesów stworzona na podstawie nagrań jest dokładniejsza niż ręcznie pisane dokumenty, ponieważ nie polega na niczyjej pamięci ani interpretacji.

To samo dotyczy proszenia ogólnego czatu AI o napisanie SOP. Pisze on na podstawie Twojego opisu, w tym kroków, które pominąłeś, ponieważ wydawały Ci się oczywiste. A to właśnie te kroki sprawiają, że nowy pracownik utyka.

Czego szukać w narzędziu do dokumentacji procesów#

• Uczy się z Twojego ekranu, a nie z opisu. Nagrywanie wygrywa z wypisywaniem kroków.
• Ustrukturyzowany wynik. Numerowane kroki ze zrzutami ekranu, a nie transkrypcja czy ściana tekstu.
• Wideo i przewodnik pisemny z jednego nagrania. Niektórzy wolą oglądać, inni skanować tekst; robienie tego osobno to podwójna praca.
• Prawdziwa edycja. Będziesz chciał dodawać ostrzeżenia, zmieniać brzmienie kroków i poprawiać terminy w porządnym edytorze.
• Publikacja tam, gdzie czyta Twój zespół. Sprawdź, na jakich platformach publikuje narzędzie i w jakim planie.
• Szybka ścieżka aktualizacji. Gdy proces się zmienia, ponowne wykonanie przewodnika powinno zająć tyle samo czasu, co nagranie go za pierwszym razem, nie dłużej.

Dla zespołów chcących zbudować pełny przepływ pracy generatora SOP AI, obejmujący kontrolę wersji, recenzję zespołową i publikację w wielu językach, ten filar obejmuje pełny obraz. Więcej informacji o najlepszym oprogramowaniu SOP AI dostępnym obecnie znajdziesz w tym zestawieniu, które porównuje główne opcje.

Zacznij od procesu, o który Twój zespół pyta najczęściej. Nagraj go raz. Pozwól Clevera go udokumentować. Opublikuj go przed końcem dnia.