Jak poprawnie pisać instrukcje

Spisu treści:

Anonim

Wiele osób nie przeczyta instrukcji, chyba że w ostateczności. Gdy ludzie je przeczytają, są pomocni tylko wtedy, gdy są napisane jasnym, zwięzłym językiem. Kiedy zrozumiesz swoich odbiorców, będziesz lepiej przygotowany do przedstawienia wstępu, a następnie instrukcji.

Zbadaj swoją publiczność

Instrukcje zazwyczaj mówią czytelnikowi, jak wykonać, zbudować, obsługiwać lub konserwować produkt lub procedurę. Najpierw zakwalifikuj swoich docelowych odbiorców, aby dowiedzieć się, jak dobrze rozumieją dany temat. Na przykład, jeśli piszesz instrukcje dla nowych pracowników, powinny one być napisane prostym językiem, podczas gdy instrukcje dla kierownictwa wyższego szczebla mogą zawierać więcej żargonu branżowego. Użyj języka odpowiedniego dla czytelników i umieść tyle szczegółów, ile potrzeba do wykonania zadania.

Utwórz wstęp

Bardzo często czytelnicy pomijają wstęp do narracji i przechodzą od razu do instrukcji. Jednym ze sposobów pomocy czytelnikom w poruszaniu się po wprowadzeniu jest napisanie wyjaśnienia lub przyczyny instrukcji na liście numerowanej zamiast w formie akapitu. Czytelnicy częściej przeglądają listę. Uwzględnij cel instrukcji, kto powinien przeczytać dokument i co zawiera, każdy pod osobnym nagłówkiem. To wprowadzenie daje również czytelnikom wskazówkę co do tego, czego nie dotyczy.

Użyj aktywnego głosu

Powstrzymaj się od używania biernego głosu, takiego jak "Biały przewód powinien być włożony do wtyczki A." Zamiast tego, zapisz instrukcję jako polecenia wymagające aktywnego głosu, na przykład "Wstaw biały przewód do wtyczki A." Niezależnie od tego, czy piszesz listę, narracja lub książeczka, rozbijaj długie zdania z wieloma krokami na krótkie instrukcje wymienione w nagłówkach. Podziel zdania zawierające słowo "i" na krótsze zdania. Zamiast pisać "Kabel powinien być połączony i umieszczony w czerwonym gniazdku", napisz dwa zdania zaczynające się od czasowników akcji, takich jak "Splice the cable. Umieść połączony kabel w czerwonym gniazdku ". Czysty, odważny nagłówek mógłby powiedzieć coś w stylu" Podłącz przewody ".

Oddzielne akcje od informacji wyjaśniających

Bardzo często instrukcje również wymagają wyjaśnień. Napisz komentarze objaśniające na jeden z dwóch sposobów. Pogrubiaj instrukcje tak, aby się wyróżniały lub dostarczaj wyjaśnienia w osobnej kolumnie dla odniesienia. Jedna taktyka polega na umieszczeniu kroków po jednej stronie dokumentu, z wyjaśnieniami w krótkim akapicie w kolumnie obok siebie. Innym, bardziej skutecznym sposobem jest pogrubienie instrukcji i ukończenie kroku, pisząc wyjaśnienie. Na przykład: "Naciśnij czerwony przycisk przez trzy sekundy (pogrubiony). Pozwoli to zapalić światło."