Zamień nagranie ekranu w instrukcję krok po kroku

Dokumentacja to druga połowa tutorialu

Jedni oglądają, inni przeglądają tekst, a wyszukiwarki indeksują słowa. Tworzenie filmu i pisemnej instrukcji osobno oznacza dwukrotne opisywanie tego samego przewodnika. Capture rozumie twój tutorial na tyle dobrze, by oczyścić jego lektora, więc wersja pisemna powstaje z tej samej pracy.

Jak działa Generate guide

1. Zmontuj tutorial jak zwykle. Cięcia i przycięcia przenoszą się do instrukcji.
2. Kliknij Generate guide w edytorze. Jeśli projekt nie ma jeszcze transkrypcji, Capture najpierw ją tworzy.
3. Capture pisze instrukcję na podstawie transkrypcji, preferując twojego zoptymalizowanego lektora, oraz twoich kliknięć: tytuł, wstęp i numerowane kroki.
4. Każdy krok dostaje zrzut ekranu z nagrania z momentu kliknięcia oraz link przenoszący do tego momentu w filmie.

Jeśli później zmienisz montaż, instrukcja zostanie oznaczona jako nieaktualna. Wygeneruj ją ponownie, żeby znów była zgodna.

Jak pisać dokumentację oprogramowania, gdy wolisz ją pokazać

Zapytaj kogokolwiek, kto prowadzi centrum pomocy, co spowalnia pisanie dokumentacji, a odpowiedź nigdy nie brzmi „pisanie na klawiaturze”. Spowalnia ustalanie kolejności kroków, pamiętanie o wymaganiu wstępnym, które sam pomijasz odruchowo, i opisywanie ekranu z pamięci na tyle precyzyjnie, by obca osoba mogła za tym podążać.

Pokazanie zadania rozwiązuje wszystkie trzy problemy. Wykonujesz kroki we właściwej kolejności, bo wymusza ją produkt, wymaganie wstępne pojawia się, bo faktycznie je spełniasz, a ekran jest opisany dokładnie, bo nagranie to właśnie ten ekran. Potem edytujesz szkic zamiast patrzeć na pustą stronę.

Dobra dokumentacja wciąż wymaga człowieka, który zdecyduje, co jest ważne. Nie wymaga jednak kogoś, kto przepisuje własne kliknięcia.

Gdzie to się mieści w Braiv Capture

Instrukcje to dodatkowa funkcja Braiv Capture, zbudowana na optymalizacji lektora. Instrukcje są pisane w języku źródłowym tutorialu. Pisemne instrukcje na podstawie filmów, które są już na YouTube, znajdziesz w opisie funkcji film z YouTube jako artykuł pomocy.