Jak napisać instrukcję krok po kroku, którą da się wykonać

Żeby napisać dobrą instrukcję, określ punkt startu, ułóż czynności w kolejności i pokaż, po czym poznać poprawny wynik. Dopisz też, co zrobić, gdy zwykła ścieżka nie działa. Czytelnik nie powinien odgadywać reguł, które dla autora są oczywiste.

Instrukcja przydaje się wszędzie tam, gdzie kolejna osoba ma samodzielnie wykonać powtarzalne zadanie: zarezerwować salę, zgłosić usterkę, przygotować paczkę materiałów czy obsłużyć prostą funkcję programu. Nie musi wyglądać jak urzędowa procedura. Czasem wystarczy pół strony — pod warunkiem że nie brakuje najważniejszego kroku.

Dlaczego samo „sprawdź i zapisz” nie wystarcza

„Przed spotkaniem sprawdź dostępność sali i wpisz rezerwację do kalendarza. W razie problemów skontaktuj się z odpowiednią osobą”.

Zdanie brzmi rozsądnie, ale nowa osoba musi sama ustalić nazwę kalendarza, sposób oznaczenia sali i to, kto może jej pomóc. Nie wie też, czy wpis od razu rezerwuje pomieszczenie, czy dopiero wysyła prośbę o zgodę. To nie problem interpunkcji. W tekście brakuje informacji potrzebnych do działania.

Zanim zaczniesz wygładzać język, wypisz te luki i potwierdź zasady z osobą odpowiedzialną za zadanie. Nie zamieniaj nieznanej reguły w pewne polecenie. Jeśli dwa zespoły rezerwują sale inaczej, przygotuj osobne wersje albo wyraźnie wskaż, której sytuacji dotyczy instrukcja.

Najpierw ustal, co oznacza wykonane zadanie

Tytuł „Obsługa kalendarza” obejmuje zbyt wiele. „Rezerwacja sali Brzoza na spotkanie zespołu” wskazuje jeden rezultat. Tytuły nazywające zadanie i listy numerowane dla kolejnych czynności zaleca również poradnik redakcyjny Microsoftu.

Pod tytułem zapisz tylko to, co trzeba wiedzieć przed pierwszym krokiem. W naszym przykładzie będą to data, obie godziny oraz dostęp do właściwego kalendarza. Jeżeli dostęp wymaga wcześniejszego nadania uprawnień, czytelnik powinien dowiedzieć się o tym przed rozpoczęciem rezerwacji.

Ustal też punkt końcowy. „Zajmij się rezerwacją” nie daje sposobu sprawdzenia wyniku. „Kalendarz pokazuje zapis dla właściwej sali i przedziału czasu, bez konfliktu z inną rezerwacją” już go daje. Samo kliknięcie przycisku nie musi oznaczać sukcesu.

To odróżnia instrukcję od notatki ze spotkania. Notatka może zapisać, że ktoś ma zarezerwować salę. Instrukcja wyjaśnia, jak wykonać tę czynność także następnym razem. Z kolei brief do tekstu określa wymagania wobec zamawianego materiału, nie opisuje całej ścieżki wykonania powtarzalnej operacji.

Pisz kroki tak, żeby dało się na chwilę oderwać wzrok

Czytelnik zwykle przeplata czytanie z pracą. Powinien móc wrócić do numeru kroku i szybko znaleźć następną czynność. Zamiast „Należy dokonać weryfikacji poprawności wprowadzonych danych” napisz „Porównaj datę oraz godzinę rozpoczęcia i zakończenia z planem spotkania”. Krótsze zdanie nie tylko lepiej brzmi — mówi, co porównać.

Gdy miejsce działania jest nieoczywiste, podaj je przed poleceniem. Tę kolejność opisuje Google w zasadach pisania procedur. „We wspólnym kalendarzu Sale wybierz dzień spotkania” prowadzi sprawniej niż zdanie, z którego dopiero na końcu wynika, o który kalendarz chodzi.

Nie rozbijaj jednak każdej drobnej czynności na osobny akapit. „Ustaw godzinę rozpoczęcia i zakończenia. Zapisz wydarzenie” może stanowić jeden krótki krok. Oddziel go, jeśli zapis prowadzi do kolejnego ekranu, wymaga decyzji albo łatwo go przeoczyć. Podział ma pomagać w wykonaniu zadania, a nie produkować długą listę.

W poradniku o programie zapisuj rzeczywiste nazwy opcji i określ wersję, jeśli zmienia ona przebieg. Nie polegaj wyłącznie na „zielonym przycisku po prawej”. Kolor lub położenie może się zmienić, a część osób nie korzysta z obrazu. Zrzut powinien uzupełniać tekst, nie zastępować brakującej czynności.

Przykład instrukcji z drogą wyjścia z konfliktu

Poniższy przykład dotyczy fikcyjnego zespołu, w którym zapis we wspólnym kalendarzu jest rezerwacją sali i nie wymaga dodatkowej akceptacji. Nie jest instrukcją konkretnej aplikacji. W organizacji korzystającej z zatwierdzania rezerwacji potrzebny będzie inny krok końcowy.

Rezerwacja sali Brzoza

Zanim zaczniesz: przygotuj termin spotkania do sześciu osób i dostęp do edycji wspólnego kalendarza „Sale”. Jeśli nie masz dostępu, poproś opiekuna kalendarza. Nie korzystaj z konta innej osoby.

1. Otwórz kalendarz „Sale” i przejdź do dnia spotkania.
2. Sprawdź wpisy dotyczące sali Brzoza. Jeśli choć jeden częściowo pokrywa się z planowanym czasem, wybierz inny termin i sprawdź go ponownie. Nie usuwaj cudzej rezerwacji. Jeżeli nie możesz zmienić terminu, przerwij i skontaktuj się z opiekunem kalendarza.
3. W wolnym przedziale dodaj wydarzenie. W tytule wpisz „Brzoza — [temat spotkania]”. Zastąp nawias krótkim tematem bez danych poufnych.
4. Ustaw datę oraz godzinę rozpoczęcia i zakończenia. Zapisz wydarzenie.
5. Otwórz zapisany wpis i porównaj salę, datę oraz obie godziny z planem. Sprawdź, czy w międzyczasie nie pojawił się drugi wpis w tym samym terminie. Jeśli tak, zgłoś konflikt opiekunowi, zamiast uznawać rezerwację za rozstrzygniętą.

Gotowe, gdy kalendarz pokazuje Twój zapis dla sali Brzoza we właściwym terminie i nie ma nakładającej się rezerwacji. Jeśli po zapisaniu nie ma wpisu, nie wysyłaj potwierdzenia sali uczestnikom. Zgłoś problem opiekunowi, podając datę i godziny.

Najważniejsza zmiana w stosunku do pierwszego zdania dotyczy kroku drugiego. „Sprawdź dostępność” stało się regułą decyzji. Czytelnik wie, co sprawdza i kiedy ma przerwać. Nazwę roli „opiekun kalendarza” trzeba w rzeczywistym dokumencie powiązać z działającym kontaktem wewnętrznym.

Powiększ

Sprawdź instrukcję na zwykłym przypadku i na wyjątku

Najpierw wykonaj próbę logiczną. Dla spotkania 10:00–10:30 i wolnej sali ścieżka prowadzi do dodania wpisu, zapisu i kontroli obu godzin. Teraz załóż istniejącą rezerwację 10:15–11:00. Instrukcja musi zatrzymać rezerwację już w kroku drugim, mimo że początek o 10:00 jest wolny. Jeśli prowadzi dalej, brakuje warunku albo jest on źle sformułowany.

To sprawdza logikę tekstu, nie dowodzi jeszcze, że nowa osoba go rozumie. Daj instrukcję komuś z grupy odbiorców, kto nie zna procedury. Poproś o wykonanie zadania na bezpiecznych danych próbnych. Nie podpowiadaj od razu, gdzie kliknąć i co oznacza skrót. Zapisz numer kroku, miejsce zawahania oraz rezultat. Takie obserwowanie wykonania rzeczywistego zadania jest podstawą podejścia opisanego w poradniku testów użyteczności GOV.UK.

Zamiast pytać tylko „Czy wszystko jest jasne?”, sprawdź, czy osoba znalazła właściwe miejsce, wykonała czynności i rozpoznała wynik. Jeśli musisz wyjaśnić coś ustnie, rozważ dopisanie właśnie tej informacji. Nie dopisuj całej historii narzędzia. Popraw konkretny brak i sprawdź dotknięty fragment ponownie. Próbę przerwij przed działaniem mogącym zmienić prawdziwe dane lub wysłać wiadomość do klientów.

Wyznacz osobę, która poprawi instrukcję po zmianie zasad

Nawet czytelny tekst przestaje pomagać, gdy wskazuje nieaktualny formularz albo dawną osobę kontaktową. Dodaj opiekuna instrukcji i datę rzeczywistego sprawdzenia. Jeżeli procedura zależy od wersji programu lub wewnętrznego regulaminu, zapisz również ten kontekst. Sama świeża data bez ponownego przejścia zadania nie potwierdza aktualności.

Trzymaj jedną aktualną wersję w ustalonym miejscu. Gdy problem dotyczy konkretnego sposobu przygotowania pliku, odsyłaj do właściwej procedury zamiast przepisywać ją w kilku dokumentach — na przykład do przygotowania dokumentu do korekty w Wordzie. Ten poradnik uczy pisania instrukcji; nie zastępuje wymagań bezpieczeństwa ani specjalistycznych procedur obowiązujących w danej organizacji.

Gdy procedura jest kompletna, możesz usunąć rozwlekłe sformułowania bez gubienia warunków. Nie skracaj instrukcji kosztem opisanej ścieżki wyjątku ani kryterium poprawnego wyniku.