Zawartość
Instrukcje obsługi to doskonała aplikacja w dziedzinie pisania technicznego. Dobra instrukcja obsługi powie użytkownikowi wszystko, co musi zrobić, aby móc skutecznie i bezpiecznie śledzić dane zadanie.
Instrukcje
-
Zidentyfikuj osoby, którym zadanie zostanie przydzielone i napisz myśląc o ich poziomie zrozumienia. Znajomość grupy docelowej jest kluczową częścią techniki pisania.
-
Napisz podsumowanie na początku instrukcji, jeśli będzie zawierać więcej niż kilka stron. Jeśli podręcznik jest za długi, dołącz indeks z tyłu.
-
Napisz krótkie wprowadzenie, które opisuje zadanie w kategoriach jakościowych. Daj użytkownikowi wyobrażenie o zadaniu i jaki będzie końcowy rezultat. Tę okazję należy wykorzystać, aby zapewnić ważne porady, które pomogą użytkownikowi wykonać zadanie prawidłowo i skutecznie.
-
W razie potrzeby podaj listę odpowiedniego sprzętu i przedmiotów, których użytkownik będzie potrzebował do wykonania zadania. Jeśli instrukcja obsługi służy do montażu produktu i towarzyszy składanemu produktowi, należy dołączyć oddzielną listę wszystkich części, które powinny zostać dostarczone użytkownikowi.
-
Wyraźnie określ wszelkie istotne ryzyko, które może spowodować obrażenia, śmierć, uszkodzenie mienia i inne zagrożenia. Użyj odpowiedniego języka z prawami miejsca, w którym będzie sprzedawany podręcznik.
-
Napisz każdą akcję wyciągu w oddzielnym kroku, podając wszystkie informacje, które użytkownik będzie musiał wykonać, aby wykonać ten krok. Pisanie musi być dosłowne, prosto do rzeczy i nie może być niejednoznaczne.
-
Jeśli w podręczniku jest miejsce, dołączaj liczby i diagramy za każdym razem, gdy usuniesz trudny krok dla użytkownika.
-
Jeśli to konieczne, utwórz i dołącz listę porad, które pomogą użytkownikowi wykonać zadanie.