Jak pisać dobre instrukcje?

Pisanie instrukcji to nic trudnego. Pisanie dobrych instrukcji to całkowicie inna historia. To nie lada wyzwanie wymagające odpowiedniego podejścia i umiejętności. Dzisiaj chcemy Wam przedstawić kilka wskazówek jak pisać skuteczne instrukcje.

Przepis pochodzi z blogu Laury Schneider. Oryginalny artykuł można znaleźć tutaj. Poniżej przedstawiamy streszczenio-tłumaczenio-interpretację tegoż artykułu. 🙂

Postaw się w sytuacji użytkownika

Po pierwsze, użytkownik nie wie nic na temat produktu, który opisujesz. Po drugie, nie poświęci czasu na czytanie całej instrukcji zanim rozpocznie pracę. Użytkownik korzysta z Twojego produktu w konkretnym celu.

Przyjmij do wiadomości, że ludzie nie chcą czytać Twoich tekstów

Brutalne, ale prawdziwe. Pisanie dobrych instrukcji wymaga uświadomienia sobie, że użytkownicy nie chcą się uczyć jak używać produktu, tylko chcą wykonać konkretne zadanie. Do dokumentacji sięgają w akcie desperacji, więc na tym etapie są już sfustrowani i nie wiedzą co dalej robić.

Użytkownicy są już sfrustrowani

Jako twórca instrukcji jesteś w kiepskiej sytuacji, ponieważ użytkownicy, których prawdopodobnie nigdy nie spotkasz, na etapie sięgania po dokument są już sfrustrowani. Dlatego musisz być dla nich miły i dać im dokładne i przejrzyste wskazówki, które pozwolą im jak najszybciej znaleźć właściwą ścieżkę.

Zanim przystąpisz do pisania

Musisz wiedzieć jaki styl należy zastosować w instrukcjach. Rozejrzyj się za podręcznikiem stylu używanym w Twojej firmie i zdobądź najnowszą wersję Microsoft Manual of Style for Technical Publications. A co z użytkownikami Apple? Albo już znają styl pisania Microsoftu albo nie będą zagubieni, ponieważ będzie on stosowany konsekwentnie w całym dokumencie.

Słownik i tezaurus nie zaszkodzą. Można je znaleźć w internecie, a firmowy podręcznik stylu powinien określać, które z nich wybrać. Jeśli masz wątpliwości, użyj słownika Merriam Webster.

Magiczna formuła

  1. Gdzie jestem?
    Umieść informację, w którym miejscu systemu rozpoczyna się procedura.
  2. Co mam robić?
    Napisz jakie kroki powinien wykonać użytkownik.
  3. Co się stało?
    Opisz rezultat.

W powyższej metodzie rozpoczynasz od czegoś co użytkownik już zna, a następnie dajesz mu coś nowego. Kluczowe w tym wypadku są zrozumiałe tytuły i nagłówki.

Dzięki zrozumiałemu tytułowi sfrustrowany użytkownik szybko ustali czy dana procedura rozwiąże jego problem, dzięki informacji o miejscu, w którym powinien zacząć wie, które okno otworzyć przed rozpoczęciem, a dzięki opisowi rezultatu, wie jak powinien wyglądać wynik poprawnie wykonanej procedury.

Pisanie czas zacząć

Znamy już zasady, więc możemy przystąpić do działania cały czas pamiętając o perspektywie użytkownika.

Tytuł rozdziału powinien brzmieć „Jak wykonać ABC”, a sam rozdział powinien zawierać tylko i wyłącznie instrukcje, który dotyczą wykonania zadania przedstawionego w tytule. Zastosuj „magiczną formułę”, np.

  1. W głównym oknie wybierz wszystkie żądane opcje. Naciśnij OK. Pojawi się drugie okno z obecnym statusem opcji, które zostały wybrane.
  2. Sprawdź czy wszystkie opcje wybrane w drugim oknie są poprawne:
    • Jeśli wszystkie opcje są poprawne, naciśnij Aktywuj Opcje. Pojawi się kolejne okno.
    • Jeśli opcje nie są poprawne, naciśnij Back, żeby powrócić do głównego okna i wybrać inne opcje.

Instrukcja gotowa, co dalej?

Po zakończeniu pisania, sprawdź tekst pod kątem poprawności językowej. Następnie, oddaj tekst eskpertowi w kwestiach merytorycznych (SME), a najlpiej kilku eskpertom. Pozmieniaj co trzeba, po czym oddaj tekst edytorowi. Po uwzględnieniu korekt, tekst jest właściwie gotowy do publikacji.

Zmiany wprowadzane przez eksperta albo edytora powinny być przez Ciebie akceptowane praktycznie w każdym wypadku – w końcu znają się na tym co robią. Jeśli zdecydowanie nie zgadzasz się z jakąś zmianą, przedyskutuj ją z ekspertem lub edytorem.

Przetestuj instrukcję

Zorganizuj grupę ludzi, którzy przejdą Twoją instrukcję od początku do końca i zanotują, w których miejscach mieli wątpliwości albo gdzie kroki były niepoprawne. Najlepiej byłoby, gdyby testowaniem zajęli się prawdziwi użytkownicy produktu. Jeśli nie ma takiej możliwości, wybierz kilka osób w firmie, które nie znają Twojej instrukcji. Ich uwagi będą równie wartościowe jak uwagi ekspertów, ponieważ te osoby również dobrze znają produkt.

Wnioski końcowe

Ogólnie, wnioski dotyczące pisania instrukcji dla oprogramowania są następujące:

  1. Użytkownicy są sfrustrowani kiedy czytają Twoje instrukcje.
  2. Musisz uspokoić użytkownika przez poinformowanie go gdzie jest, co ma robić i do czego go to doprowadzi.
  3. Potrzebujesz ekspertów, którzy sprawdzą Twoje instrukcje pod kątem merytorycznym i językowym.
  4. Zmiany wprowadzone przez eskpertów akceptuj bez gadania, chyba, że ZDECYDOWANIE się z nimi nie zgadzasz. Wtedy porozmawiaj o tym z ekspertem.
  5. Testowanie użyteczności to najlepszy sposób na sprawdzenie czy Twoja instrukcja sprosta wymaganiom użytkowników.