Jak pisać instrukcje, które ludzie rozumieją za pierwszym razem

Klienci piszą do działu wsparcia, nowi pracownicy zadają te same pytania, a zadanie wykonane „zgodnie z instrukcją” i tak kończy się błędem. Zwykle winna jest sama instrukcja: napisała ją osoba, która zna zadanie zbyt dobrze, żeby zauważyć, gdzie nowicjusz się gubi. Oto siedem zasad, dzięki którym instrukcje działają za pierwszym razem, niezależnie od tego, czy to instrukcja obsługi, artykuł w centrum pomocy, czy procedura w pracy.

1. Jedno zadanie na instrukcję

„Jak skonfigurować konto” to zbyt szeroki temat. „Jak zmienić hasło” i „Jak dodać członka zespołu” to dwie osobne instrukcje. Czytelnik szuka jednego zadania, znajduje je, wykonuje i wychodzi.

2. Zacznij od rezultatu i tego, co potrzebne

W pierwszych dwóch linijkach napisz, co czytelnik osiągnie i czego potrzebuje przed rozpoczęciem: uprawnień, pliku, hasła, dziesięciu minut czasu. Nic tak nie irytuje jak odkrycie w kroku 7, że coś było potrzebne od samego początku.

3. Numerowane kroki, w każdym jedna czynność

Każdy krok to jedna czynność, zaczynająca się od czasownika: „Otwórz Ustawienia”, „Kliknij Zapisz”. Jeśli w kroku pojawia się „a następnie”, to są dwa kroki. Numery pozwalają czytelnikowi nie zgubić miejsca, a działowi wsparcia napisać „zobacz krok 4”.

4. Słowa czytelnika, nie twoje

Nazwy przycisków i menu zapisuj dokładnie tak, jak czytelnik widzi je na ekranie. Unikaj wewnętrznego żargonu i skrótów; jeśli jakiegoś terminu nie da się uniknąć, wyjaśnij go przy pierwszym użyciu.

5. Pokaż, co powinno się stać

Po ważnym kroku opisz rezultat: „Pojawi się zielony komunikat: Zapisano”. Czytelnik wie, że jest na dobrej drodze, i od razu zauważa, gdy coś pójdzie nie tak.

6. Ostrzeżenia przed krokiem, nie po nim

„Zanim klikniesz Usuń, wyeksportuj dane: usuniętych danych nie można przywrócić”. Ostrzeżenie umieszczone po kroku przychodzi za późno.

7. Przetestuj na kimś nowym

Daj instrukcję osobie, która nigdy nie wykonywała tego zadania, i obserwuj, nie pomagając. Każde miejsce, w którym się waha, pyta lub popełnia błąd, trzeba napisać od nowa. Pięć minut testu wykrywa więcej problemów niż godzina ponownego czytania.

Ilustracje i struktura

• Zrzuty ekranu do kroków wykonywanych na ekranie, z zaznaczonym właściwym przyciskiem; aktualizuj je, gdy zmienia się interfejs.
• Nagłówki w długich procedurach, żeby czytelnik mógł przejść do potrzebnej części.
• Sekcja „Co jeśli” na końcu, z typowymi problemami: „Jeśli e-mail nie dotarł, sprawdź folder spam”.

Podsumowanie

Jedno zadanie, na początku rezultat i wymagania, numerowane kroki z jedną czynnością, słowa czytelnika, oczekiwany rezultat, ostrzeżenia w porę i test na prawdziwej osobie. Jeśli potrzebujesz instrukcji, zestawu artykułów pomocy lub procedur, zamów instrukcje i procedury SOP: opisujesz produkt lub proces, a dostajesz jasne, uporządkowane instrukcje. Płatność zostaje zwolniona dopiero po zaakceptowaniu pracy.