Szkolenie AI dla autorów dokumentacji technicznej

Warsztat wokół tekstów, które wracają do redakcji

W Syntalith proponujemy szkolenie zespołowe oparte na drodze dokumentu od notatki produktowej do tekstu dla użytkownika. Przy przygotowaniu programu ustalamy, na czym zatrzymuje się praca: czy autor musi ponownie pytać o zakres funkcji, trudno mu ułożyć materiał, czy uwagi do jednej wersji gubią się w następnej. Do tego dobieramy zadania i sposób omówienia. Firma wnosi wiedzę o produkcie i oczekiwania wobec dokumentacji, a Syntalith przygotowuje ćwiczenia z wykorzystaniem AI na tych materiałach.

Zakres może obejmować planowanie artykułu, redagowanie na podstawie odpowiedzi eksperta oraz zmianę istniejącej dokumentacji po wydaniu nowej wersji produktu. Praca nad własnym szkicem pozwala omówić konkretny problem: czy warunek jest widoczny, czy nazwa zgadza się z produktem i czy użytkownik rozumie, do czego służy opisana funkcja. Kolejna samodzielna próba pokazuje, które poprawki autor potrafi zastosować w innym materiale.

Mniej ogólnych pytań do eksperta

Notatka produktowa może wystarczać osobie, która zna funkcję, a pozostawiać autora bez informacji potrzebnych czytelnikowi. Dlatego część zajęć dotyczy wyboru odbiorcy i planu tekstu, zanim AI rozwinie krótkie zapiski w kilka akapitów. Autor porównuje możliwe układy i decyduje, które pytanie użytkownika ma wyjaśnić dany fragment.

Gdy notatka mówi jedynie o eksporcie danych, przydatne pytanie do eksperta dotyczy tego, kto może go wykonać i od której wersji. Odpowiedź trafia do szkicu w miejscu, gdzie czytelnik jej potrzebuje. Przy instrukcji wykonania zadania dochodzą pytania o czynności w produkcie. Tak przygotowany materiał daje ekspertowi konkretny tekst do sprawdzenia, zamiast ogólnej prośby o opisanie funkcji od początku.

Ten sam warsztat może objąć skracanie długich objaśnień i spójne nazewnictwo. Autor porównuje propozycje AI z firmowym słownictwem oraz sąsiednimi fragmentami dokumentacji. Redaktor ocenia, czy zmiana ułatwia lekturę, a ekspert potwierdza opis funkcji.

Co zmienia konkretna uwaga do szkicu

Załóżmy, że notatka mówi: w wersji 4 administratorzy mogą eksportować historię zmian jako CSV. Szkic AI zachęca każdego czytelnika do eksportu, pomijając rolę i wersję. Użyteczna poprawka brzmi: „W wersji 4 administratorzy mogą wyeksportować historię zmian do pliku CSV”. Warunek pojawia się od razu, więc użytkownik rozpoznaje, czy opis go dotyczy.

Podczas omówienia istotna jest ta decyzja redakcyjna: informacja o odbiorcy powinna być widoczna, zanim czytelnik zacznie traktować tekst jako instrukcję dla siebie. Autor dostaje uwagę odnoszącą się do miejsca w jego szkicu, poprawia je i sprawdza spójność z resztą artykułu. Późniejszym samodzielnym zadaniem może być aktualizacja na podstawie notatki, że w wersji 5 zwykli użytkownicy otrzymują eksport PDF: trzeba ponownie ustalić treść zdania, zachowując nową rolę, wersję i format.

Wykorzystać obecne narzędzia

Dokumentacja AI Positron w Oxygen Content Fusion opisuje przeredagowanie tekstu, poprawę czytelności, przegląd oraz porównanie propozycji przed zastosowaniem. Wymaga to roli Author i zainstalowanej, skonfigurowanej wtyczki. Jeśli firma udostępnia te funkcje, zajęcia mogą uwzględniać pracę w obecnym edytorze.

Przy powtarzalnych opisach wystarczyć może lepszy szablon z miejscem na odbiorcę i wersję produktu. Szkolenie jest przydatne, gdy autorzy potrzebują praktyki w planowaniu i redagowaniu różnych materiałów oraz rozmowie z ekspertem. Wybór lokalnego środowiska do tworzenia opisów to osobna decyzja, omówiona w artykule o lokalnym modelu do polskich opisów technicznych.

Kogo zaangażować i od czego zacząć

Autorzy potrzebują czasu na własny tekst i poprawkę. Ekspert produktowy oraz redaktor mogą dołączyć do omówienia wybranych fragmentów, w których ich uwagi pomagają rozstrzygnąć zakres lub sposób wyjaśnienia. Doświadczenie w pisaniu i znajomość AI uwzględniamy osobno. Doświadczony autor może zaczynać od obsługi szkicu, a swobodny użytkownik narzędzia pracować nad dłuższymi notatkami lub zmianą kilku powiązanych fragmentów.

Program uzgadniamy z zespołem, w tym zakres ćwiczeń i ewentualną pracę między spotkaniami z późniejszym omówieniem. Można korzystać z fikcyjnych materiałów; firmowe dokumenty muszą być dopuszczone do wybranego narzędzia.

Na pierwszej rozmowie opowiedz o tekście, który wielokrotnie wracał od eksperta lub redaktora, i o poprawkach, które trzeba było wprowadzić. To pozwoli ustalić, jaką część pracy objąć szkoleniem i kogo zaprosić do wspólnego omówienia. Informacje o współpracy znajdziesz w cenniku Syntalith.