Jak pisać instrukcje?

Jak pisać instrukcje?
0 votes, 0.00 avg. rating (0% score)

W jednej z książek o absurdach PRL-u przeczytałem instrukcję obsługi ubikacji, czyli i całego procesu wypróżniania się. Wcześniej nie zdawałem sobie sprawy z tego, że pójście za potrzebą jest aż tak zagmatwane! Jestem pewny, że gdybym przygodę z WC rozpoczął od przeczytania instrukcji to do dziś robiłbym wyłącznie w pieluchę!

Pisanie instrukcji nie jest sprawą prostą. Chociażby przez to, że użytkownicy potrafią zrobić ze stronami www rzeczy, o których się fizjologom nie śniło. Każdy z Was zaznał pewnie takich cudów. Nim więcej się ich zaświadczy, tym lepiej, bo na całe szczęście zaczynają się powielać, a więc zaznajemy łaski objawienia.

Skoro większość z nas ma styczność z grafiką komputerową warto posilić się pewnym przykładem, który  uświadomi nam różnice między instrukcją a instrukcją. Czy widzicie różnice między tutorialami publikowanymi w Computer Arts i Psd Magazynie (czy nawet na stronie PsdTuts+)? Dla mnie są one kolosalne, jeśli o sposób opisu ćwiczeń chodzi, bo efekty jakie mamy uzyskać mogą być na tym samym poziomie. Ważne jest to, czy użytkownik jest w stanie bez problemu z instruktarzem pracować i uzyskać prezentowany efekt.

1. Instrukcja ma spełniać rolę streszczenia

Każdemu z nas za czasów szkolnych zdarzyło się pewnie przeglądać streszczenia lektur szkolnych. Chociażby po to, żeby sprawdzić, czy właściwie odczytaliśmy przesłanie przeczytanej książki.

2. W instrukcji należy unikać żargonu i terminologii informatycznej

Język fachowy należy ograniczyć do słów niezbędnych. Takich, których nie można zastąpić zrozumiałymi dla laika słowami i tych, które użytkownik spotka np. w styczności z panelem admina.

Nie zmuszajmy klientów do katowania Słowników Pojęć Informatycznych, nie nakłaniajmy ich do nauki 100 fachowych słów. Nie róbmy tego tylko po to, aby popisać się wiedzą, kompetencjami, sztucznie zwiększając skalę trudności. Instrukcja ma umysł rozjaśniać, a nie komplikować sprawy związane z zarządzaniem serwisem internetowym.

3. Instrukcja nie idzie o zakład

Czy wiecie czemu służy żarówka? Potraficie ją wkręcić? Gdzie? W jednym z seriali widziałem sytuację typu „śmiech przez łzy”. Koleś założył się, że wepchnie szklaną bulwę żarówki do gęby. Tak też zrobił, ale żarówki już nie wyjął. Wylądował, więc w Leśnej Górze, tam zajęła się nim ekipa Burskiego. Żeby zobrazować zaraźliwość takich sytuacji dodam jeszcze, że w dalszej części serialu i taksówkarz, który idiotę do szpitala podwoził podjechał tam raz jeszcze. Tym razem on sam miał identyczny problem. Znał instrukcję, był ciekawy, włożył i już nie wyciągnął.

Instrukcja nie jest prezentacją, ani reklamą. Nie ma wychwalać czegoś pod niebiosa, nie ma szpanować, podsuwać głupich pomysłów. Musi być pozbawiona kwestii związanych z przeróbkami, modernizacją, dalszą rozbudową. Dlatego, że zawsze znajdzie się ktoś kto zapragnie temu stawić czoła, podejmie to wyzwanie.

4. Instrukcja jest jak kroki taneczne

1, 2, 3, 4 i gotowe. 1, 2, 3, 4 i po problemie. Użytkownik triumfuje sam. A my nie musimy popisywać się wiedzą dokonując telefonicznego instruktarzu z pamięci, wieczorową porą, imponując koleżankom, tym że „my wszystko tak z główki”.

Dobrze napisana instrukcja nie opiera się na zasadzie „byle jak”. Nie może być jak sławetny napis na murze „1, 2, 3… napis próbny. Spierdalamy!”.

5. Instrukcja to nie podręcznik

Podręcznik zawiera m.in. podziękowania, wprowadzenie, rozdziały i tak dalej, i tak dalej. Z podręcznika przydają nam się konkretne rozdziały. Instrukcja właściwa to te przydatne nam rozdziały.

6. Zawartość instrukcji

  • Opis funkcji bazujący na konkretnych działaniach.
  • Opis radzenia sobie z występującymi problemami.
  • Przestrogi przed czynnościami szkodliwymi, skutków których nie obejmuje gwarancja.
  • Opis spraw około tematycznych.

Przez, które rozumiem np. łączenie z serwerem FTP, robienie kopii bazy danych, dokonywanie bieżących aktualizacji systemu, kompresja, pomniejszanie fotografii.

Konfiguracja skrzynki pocztowej w programie MS Outlook już nie. Są sprawy i sprawki. Sprawy krążące wokoło stron internetowych to cały ogrom zagadnień i instrukcji. Precyzyjnie należy określić te, które są do obsługi niezbędne, i te które należy traktować jako usługi odrębne.

  • Opis zasad udzielania gwarancji.
  • Odsyłacze i namiary.

Do opasłej dokumentacji online, strony firmowej, pozycji książkowych, forum specjalistycznego.

Do tego dochodzą jeszcze adresy serwisów, kontakt z Biurem Obsługi Klienta itp.

  • Instrukcja powinna być także uzupełniona rysunkami, zdjęciami, zrzutami ekranowymi (wizualizacja).

Podsumowanie

Mniej więcej i na luzie wygląda to tak. Dodam tylko, że w moim przypadku wiele stron opierałem o CMS Joomla. I szybko rozprysły się złudzenia o tym, że nie będę musiał pisać instrukcji, a tylko odeślę do oficjalnej dokumentacji, ewentualnie wygnam po dedykowaną systemowi książkę.

Przygotowanie prostych założeń praktycznych pozwoliło klientom sprawnie obsługiwać stronę, bez ciągłego niepokojenia mnie telefonami.

Nie oznacza to, że wszystko było ładnie pięknie. Zdecydowanej większości klientów nie udało mi się wpoić nawyku robienia kopii zapasowych i bieżących aktualizacji łatających system. Niestety. Po pewnym czasie musiały więc się pojawić cyrki.

About the author