Instrukcja, której nikt nie czyta, jest kosztem bez korzyści. Różnicę robi poziom szczegółowości i moment, w którym się do niej sięga.
Pisane dla wykonawcy
Nie dla audytora. Kolejne kroki, konkretne nazwy przycisków i pól, przykłady. Opis ogólny nie pozwala niczego wykonać.
To rozróżnienie ma skutki praktyczne. Dokumenty przygotowane pod kontrolę zewnętrzną opisują, że czynność jest wykonywana zgodnie z zasadami. Dokument dla wykonawcy mówi, co kliknąć i co wpisać. Jeśli firma potrzebuje obu, lepiej prowadzić dwa teksty niż jeden, który nie służy nikomu.
Krok po kroku
Numerowana lista czynności, jedna czynność na punkt. Opis w formie ciągłego tekstu wymaga tłumaczenia na kroki przez czytelnika.
Przy każdym kroku warto podać, co ma się wydarzyć po jego wykonaniu. Wtedy czytelnik wie, czy jest we właściwym miejscu, i sam zauważy, gdy coś poszło inaczej. Bez tego dowiaduje się o pomyłce dopiero na końcu.
Zrzuty ekranu
Bardzo pomagają i bardzo szybko się starzeją. Warto ograniczyć je do miejsc naprawdę mylących.
Rozsądna zasada brzmi: obraz tam, gdzie samo znalezienie właściwego miejsca sprawia kłopot, tekst wszędzie indziej. Przy okazji trzeba sprawdzić, czy na zrzucie nie widać danych klienta albo kwot — obraz w instrukcji bywa najczęstszym miejscem przypadkowego ujawnienia takich rzeczy.
Wyjątki osobno
Główna ścieżka krótka i czytelna, przypadki nietypowe w osobnej sekcji. Wplecenie wyjątków w tok instrukcji czyni ją nieczytelną.
Ten podział wynika ze sposobu korzystania. Osoba wykonująca czynność pierwszy raz idzie przez główną ścieżkę. Osoba, która trafiła na wyjątek, szuka konkretnie tego wyjątku i chce dojść do niego od razu. Dlatego wyjątki dobrze sprawdzają się jako osobne wpisy z własnymi tytułami — porządkowanie takich zestawów opisuje tekst o strukturze bazy wiedzy.
Sprawdzenie na nowej osobie
Instrukcja jest dobra wtedy, gdy ktoś nowy wykona według niej zadanie bez pytania. Każde pytanie wskazuje miejsce do uzupełnienia.
To jednocześnie najtańszy sposób na sensowną instrukcję i najlepsze wykorzystanie pierwszych tygodni pracy nowej osoby, o czym mówi tekst o wdrażaniu nowych pracowników. Autor powinien przy tym milczeć i notować, a nie podpowiadać.
Zgodność z praktyką
Jeśli wszyscy robią inaczej niż w instrukcji, to instrukcja jest błędna — nie ludzie. Przegląd powinien zaczynać się od obserwacji.
Rozbieżność zwykle ma powód: proces się zmienił, system dostał nową wersję albo pierwotny opis nigdy nie działał w praktyce. Warto ten powód poznać przed poprawianiem tekstu. Sposoby wydobycia takiej wiedzy zbiera tekst o wiedzy w głowach ludzi.
Czego nie opisywać
Czynności wykonywanych raz w roku przez jedną osobę, która i tak sięgnie po własne notatki, oraz kroków, które za miesiąc znikną wraz ze zmianą systemu. Pisanie instrukcji w trakcie wymiany oprogramowania to praca do wyrzucenia. Wtedy lepiej zapisać samą listę czynności do opisania i wrócić do niej po zmianie.
