Specjalista ds. dokumentacji technicznej — Praca krok po kroku
Dwa polecenia w menu, jedno nieprecyzyjne zdanie w instrukcji
Praca krok po kroku · Lekcja 3 z 6
Pisz krok i jego rezultat
Użyj nazwy widocznej w interfejsie. Gdy operator powinien coś zobaczyć, opisz to po czynności.
- Co zrobić najpierwPolecenie
- Co zrobić dalejCzynność
- Jak zakończyćWynik
Przykład z pracy
Po wybraniu raportu bieżącego pojawia się lista danych z aktualnej sesji.
Ćwiczenie praktyczne
Rozpisz krok i jedno zdanie z efektem.
Dwa polecenia w menu, jedno nieprecyzyjne zdanie w instrukcji
Podejmij decyzję
Wróć do notatki z początku sprawy. Zapisz pierwsze działanie i wyjaśnij, jak pomoże rozwiązać sytuację.
Pokaż przykładową reakcję
Dopisuję wersję, nazwę polecenia i oczekiwany widok Serwis może przejść krok i rozpoznać poprawny wynik.
- Zmieniam słowo „raport” na „dokument”
- Instrukcja nadal nie wskazuje właściwego polecenia.
- Dopisuję wersję, nazwę polecenia i oczekiwany widok
- Serwis może przejść krok i rozpoznać poprawny wynik.
- Usuwam odniesienia do wersji
- Odbiorca może wykonać kroki w niezgodnym wydaniu.
Sprawdź się — opcjonalne pytanie
Która instrukcja pomaga wybrać właściwą opcję?
- Wybierz „Raport bieżący” i sprawdź nazwę aktualnej sesji
- Otwórz coś z raportem
- Kliknij w prawą część ekranu
Pokaż odpowiedź i wyjaśnienie
Wybierz „Raport bieżący” i sprawdź nazwę aktualnej sesji. Widoczna nazwa i efekt ograniczają niejasność.
Praca krok po kroku · Lekcja 4 z 6
Poproś o sprawdzenie merytoryczne
Przekaż osobie odpowiedzialnej dokument, wersję i pytanie o działanie. Zachowaj odpowiedź obok rewizji.
- Co zrobić najpierwProjekt
- Co zrobić dalejSprawdzenie techniczne
- Jak zakończyćZapis
Przykład z pracy
Inżynier sprawdza właściwy raport dla trybu D3.
Ćwiczenie praktyczne
Napisz prośbę o potwierdzenie, którą da się zweryfikować.
Sprawdź się — opcjonalne pytanie
Co przekazujesz do sprawdzenia?
- Samo pytanie „czy już?”
- Fragment, wersję i konkretny rezultat
- Dokument innego urządzenia
Pokaż odpowiedź i wyjaśnienie
Fragment, wersję i konkretny rezultat. Recenzent może odtworzyć wskazaną pracę.
Czy serwis otwiera instrukcję dla właściwej wersji?
| Punkt kontroli | Stan | Warunek odbioru |
|---|---|---|
| Menu D3 | Dwie opcje: raport bieżący i archiwum | W instrukcji występuje dokładna nazwa polecenia. |
| Oczekiwany wynik | Raport aktualnej sesji | Czytelnik rozpoznaje wynik na ekranie. |
| Portal | Dla jednego modelu otwiera się poprzedni PDF | Odnośnik prowadzi do wersji właściwej dla modelu. |
Sprawdzenie obejmuje treść kroku i plik otwierany w miejscu pracy. Zapisz wynik dla konkretnej wersji.
Sprawdź się w tej sytuacji
Napisz jeden krok z warunkiem, działaniem i oczekiwanym wynikiem.