Specjalista ds. dokumentacji technicznej
Tworzy i aktualizuje instrukcje urządzeń, porównuje ich treść z wymaganiami działu technicznego i udostępnia właściwą wersję odbiorcom.
Zobacz, co wykonasz na koniec ↓
Dwa polecenia w menu, jedno nieprecyzyjne zdanie w instrukcji
Serwis otwiera program diagnostyczny D3 i widzi polecenia „Raport bieżący” oraz „Archiwum raportów”. Instrukcja mówi jedynie „wybierz raport”.
- Rozpoznaj sprawęUstal zadanie i odbiorcę
- Podejmij decyzjęNapisz i uzgodnij
- Wyjaśnij decyzjęOpublikuj i zweryfikuj
Kompendium zawodu — pojęcia i zwroty
Pojęcia w pracy
- Rewizja
- Identyfikator wersji dokumentu, który pozwala wskazać, jakie wydanie obowiązuje.
- Warunek wstępny
- Rzecz potrzebna przed rozpoczęciem czynności, np. właściwa wersja programu.
- Procedura
- Kroki prowadzące do konkretnego wyniku.
- Punkt odbioru
- Moment, w którym użytkownik może sprawdzić, czy krok dał oczekiwany rezultat.
- Recenzja merytoryczna
- Sprawdzenie technicznej poprawności przez osobę znającą produkt.
Zwroty w typowych sytuacjach
- „Ta instrukcja dotyczy wersji D3. Potrzebuję potwierdzenia, która wersja pracuje u klienta.”
- Chroni przed wydaniem instrukcji dla innego programu.
- „Rozbiję ten akapit na kroki i dopiszę, jaki komunikat ma się pojawić.”
- Zamienia ogólny opis w działanie możliwe do sprawdzenia.
- „Serwis przeszedł nową instrukcję. Teraz sprawdzę, czy link w portalu prowadzi do zatwierdzonego wydania.”
- Wiąże treść z miejscem jej użycia.
Podstawy · Lekcja 1 z 6
Zdefiniuj zadanie odbiorcy
Nazwij konkretny wynik i określ, kto wykonuje czynność. Uwzględnij produkt i środowisko.
- Co zrobić najpierwOdbiorca
- Co zrobić dalejZadanie
- Jak zakończyćOczekiwany wynik
Przykład z pracy
Serwis ma otworzyć bieżący raport w D3.
Ćwiczenie praktyczne
Napisz cel instrukcji w jednym zdaniu.
Dwa polecenia w menu, jedno nieprecyzyjne zdanie w instrukcji
Rozpoznaj sprawę
Serwis otwiera program diagnostyczny D3 i widzi polecenia „Raport bieżący” oraz „Archiwum raportów”. Instrukcja mówi jedynie „wybierz raport”.
Zapisz, co już wiadomo i jakiej jednej informacji brakuje, żeby wykonać krok „Ustal zadanie i odbiorcę”. Zachowaj odpowiedź do kolejnej części.
Porównaj punkt wyjścia
Potwierdź cel kroku i wersję programu. Użytkownik powinien rozpoznać polecenie i wynik.
Sprawdź się — opcjonalne pytanie
Co opisuje cel procedury?
- Całą historię urządzenia
- Wynik zadania w określonej wersji
- Tylko nazwę odbiorcy
Pokaż odpowiedź i wyjaśnienie
Wynik zadania w określonej wersji. Konkretny wynik pomaga dobrać właściwe kroki.
Podstawy · Lekcja 2 z 6
Podaj warunek przed pierwszym krokiem
Wskaż wersję programu, potrzebny dostęp albo stan urządzenia. Przenieś ważny warunek przed opis czynności.
- Co zrobić najpierwProdukt
- Co zrobić dalejWersja
- Jak zakończyćWarunek
Przykład z pracy
D2 i D3 pokazują inne menu dla raportów.
Ćwiczenie praktyczne
Dopisz warunek do instrukcji dla D3.
Sprawdź się — opcjonalne pytanie
Gdzie zapiszesz wymaganą wersję?
- Wyłącznie w notatce po wydaniu
- W niepowiązanym rozdziale
- Przed wykonaniem kroków
Pokaż odpowiedź i wyjaśnienie
Przed wykonaniem kroków. Odbiorca musi móc sprawdzić zgodność przed rozpoczęciem.