Instrukcje obsługi i podręczniki użytkownika

Czym zajmują się technical writerzy? Tworzą m.in. instrukcje obsługi lub podręczniki użytkownika (ang. user guides, user manuals). A czym zajmują się instrukcje obsługi? I czym właściwie są?

Wikipedia ma odpowiedź i na to pytanie – według tej definicji są to dokumenty mające na celu ułatwić ludziom używanie różnego rodzaju produktów lub rozwiązań (systemów). Można je spotkać w różnych dziedzinach życia i przemysłu – instrukcje obsługi samochodu, pralki, komputera, oprogramowania, zabawek… Tak, tak, to są właśnie te wszystkie dokumenty których prawdziwy fachowiec nigdy nie czyta ;).

Tego typu dokumentacja może mieć różnych adresatów – administratorów systemu, wdrożeniowców, użytkowników końcowych… Powoduje to, że tworzymy dla nich różne typy podręczników, na przykład:

  • Podręczniki instalacji (installation guides) – opisujące proces instalacji i aktualizacji (upgrade’u),
  • Podręczniki administracji (administration guides) – dla zarządzających systemem,
  • Podręczniki wdrożenia lub konfiguracji (implementation/configuration guides) – dla wdrożeniowców odpowiedzialnych za przygotowanie i skonfigurowanie systemu do realizacji konkretnych działań (dla konkretnego klienta),
  • Jaktosy (how-to guides) – pokazujące jak użyć produktu w konkretnym celu,
  • Szybkostarty (quick start guides) – opisujące w jaki sposób rozpocząć pracę z urządzeniem (systemem),
  • Inne.

Jak widać, znalezienie polskich odpowiedników dla niektórych typów dokumentacji jest dość trudne – liczymy tutaj na Wasze sugestie i podpowiedzi.

Jak wygląda tego typu dokumentacja z punktu widzenia użytkownika? Zazwyczaj jest to książka – ze stroną tytułową, spisem treści, skorowidzem (index), podzielona na rozdziały wypełnione tekstem, rysunkami i tabelami. Dostarczamy ją w formie papierowej, lub elektronicznej (np. plik PDF). Więcej informacji na temat tego co powinno się znaleźć w instrukcji użytkownika znajdziecie między innymi tutaj.

A w tym miejscu świetny przykład jak nie robić instrukcji obsługi :).