Przy pisaniu instrukcji należy unikać języka perswazyjnego i przyjąć podejście oparte na zadaniu. Pisz zwięźle i jasno, koncentrując się na umożliwieniu użytkownikowi pomyślnego wykonania zadania.

Ogólnie przestrzegaj następujących wytycznych:

Zwięzłość i jasność

Utrzymuj zdania krótkie i zrozumiałe. Używaj powszechnie stosowanej terminologii, kiedy to tylko możliwe. Unikaj używania idiomów, slangu, żargonu, pseudonimów, skrótów i akronimów. Jeśli używasz terminologii, która może być nowa lub myląca, to jasno zdefiniuj każdy termin, kiedy po raz pierwszy pojawia się w instrukcji.

Znajomość odbiorców

Podczas pisania instrukcji ważne jest, aby znać swoich odbiorców, dzięki czemu uwzględniasz wszystkie niezbędne informacje i wykluczasz informacje zbędne. Znając swoją publiczność pozwala zrobić rozsądne i dobrze poinformowani założenia na podstawie publiczności prawdopodobnego tła, doświadczenia i znajomości tematu. Na przykład, jeśli piszesz instrukcje dla grupy starszych osób w lokalnym oddziale biblioteki publicznej, założenie, że znają oni podstawy otwierania konkretnego oprogramowania, może nie być bezpieczne. Jednakże, jeśli piszesz instrukcje dla grupy programistów w ramach organizacji zawodowej, może być bezpiecznie założyć, że są oni zaznajomieni z podstawami otwierania konkretnej aplikacji.

Podejmując decyzję, jakie informacje zawrzeć i wykluczyć z instrukcji, ważne jest, aby jasno określić, kim są Twoi odbiorcy i jaka jest ich prawdopodobna biegłość w temacie instrukcji i powiązanych z nim informacji ogólnych.

Jeśli publiczność prawdopodobnie będzie miała szeroki zakres doświadczenia i wiedzy, który obejmuje różne poziomy znajomości i wiedzy specjalistycznej, możesz użyć różnych technik, aby każdy zestaw instrukcji był zwięzły i skoncentrowany na jednym zadaniu, a jednocześnie dostarczał niezbędnych informacji. Na przykład, możesz stworzyć oddzielne instrukcje dla informacji wstępnych i zapewnić swoim odbiorcom środki szybkiego i łatwego dostępu do oddzielnych instrukcji (poprzez hiperłącza, załączniki, itp.).

Grafika

Obrazy mówią głośniej niż słowa. Dodanie grafiki w celu przekazania myśli może być bardziej skuteczne niż same słowa. Instrukcje, które są dobrze zilustrowane i towarzyszą instrukcjom pisemnym są zazwyczaj bardzo skuteczne. To dodaje dodatkowy poziom zrozumienia i pozwala czytelnikowi na przeglądanie lub rozwiązywanie problemów, jeśli wystąpią. Zdjęcia dodają dodatkowy wymiar, który pozwoli czytelnikowi na wizualizację produktu końcowego. Ponadto, przy użyciu grafiki należy pamiętać o tych wizualnych uczących się, i dostosować grafiki.

Chociaż zdjęcia są świetne, musisz być ostrożny, aby nie zawierać zdjęć lub ilustracji, które są mylące lub nie związane z rzeczywistymi instrukcjami pisemnymi. Jeśli połączysz kiepskie zdjęcie z instrukcją, możesz wywołać u czytelnika stres lub wprowadzić zamieszanie, próbując rozszyfrować, co masz na myśli.

Ponadto, robiąc zdjęcia, upewnij się, że obszar jest dobrze oświetlony, a zdjęcia są wyraźne i jasne. Ciemne lub niewyraźne zdjęcia są często trudne do naśladowania. Należy zadbać o to, aby fotografować obiekt w tej samej orientacji za każdym razem, aby uniknąć pomyłek i rozważyć użycie statywu.

Rozmiar jest również ważny przy używaniu obrazów w instrukcjach. Obraz, który jest zbyt mały, aby go zobaczyć, jest tak samo bezużyteczny jak obraz rozmazany.

Aby tekst i grafika dla każdego kroku były mocne i zrozumiałe, powinny wyraźnie korelować z tym krokiem instrukcji.

Formatowanie

Pamiętaj, że czytelnicy będą faktycznie wykonywać zadanie, czytając instrukcję. Dlatego nie powinieneś używać litych bloków małego, trudnego do rozszyfrowania tekstu. Upewnij się, że stworzyłeś projekt i układ strony z instrukcjami, który pozwoli na łatwą czytelność i doda jakości estetycznej. Utrzymanie prostej strony, ale z określoną hierarchią, pomoże czytelnikowi w ukończeniu kroków instrukcji.

Podczas projektowania strony, solidna hierarchia jest ważna dla łatwości skanowania. Użycie pogrubionych nagłówków, kursywy i cyfr rzymskich pomoże czytelnikowi łatwo znaleźć swoje miejsce i pomoże w ogólnym wyglądzie wizualnym.

Porządek

Ważne jest, aby twoje instrukcje były zaplanowane w logicznym postępie. Upewnij się, że problem jest jasno określony na pierwszej stronie. Podążaj za problemami z zestawem konkretnych kroków szczegółowo opisujących jak rozwiązać proponowany problem. Instrukcje techniczne muszą układać się w logiczny wzór. Na przykład, podczas montażu stołu nie byłoby dobrze, gdybyś położył wykończenie na nim, zanim miał wszystkie śruby w miejscu. Jak wspomniano wcześniej, w razie potrzeby powinny być również wyraźne grafiki, aby wyjaśnić działanie. Pamiętaj, że obraz jest wart tysiąca słów.

Testowanie i weryfikacja

Wszyscy wiemy, że instrukcje są trudne do napisania i że czasami brzmią dobrze na papierze, ale kiedy faktycznie próbujesz zastosować instrukcje do użytku, możesz odkryć, że twoje sformułowania nie mają sensu dla innych. Pamiętaj, że to, co dla Ciebie może być oczywiste lub powszechne, dla Twoich czytelników może być niezrozumiałe, więc znaj swoją publiczność. Oprócz przetestowania instrukcji na sobie, poproś kogoś, kto nie wie nic o Twoim produkcie, aby ją przetestował. Nazywa się to badaniem użyteczności. Rób notatki na temat tego, co zadziałało, a co nie, a następnie odpowiednio poprawiaj swoje instrukcje. W dłuższej perspektywie, im więcej osób przetestuje Twoje instrukcje, tym skuteczniejszy będzie ich ostateczny zestaw.