Poradniki i instrukcje

To połączenie (duża uwaga, niewielka inwestycja) tłumaczy, dlaczego tak wiele z nich jest słabych. Instrukcję pisze zwykle osoba, która zbudowała daną funkcję, za jednym posiedzeniem, z pamięci. Wychodzi tekst poprawny i nieużyteczny, bo autor nie widzi, które kroki pomija.

Osoba, która wykonała jakąś czynność pięćdziesiąt razy, przestaje rejestrować, że trzeba być zalogowanym jako administrator albo że ustawienie znajduje się w drugiej zakładce. Dla niej sekwencja ma cztery kroki. Dla nowego użytkownika ma ich siedem i zatrzymuje się na tym brakującym. To nie jest niedbałość, tylko przewidywalny efekt dobrej znajomości systemu.

Lekarstwo jest proceduralne, nie literackie. Wykonujemy czynność i notujemy każde działanie, łącznie z tymi, które wydają się zbyt drobne, żeby o nich wspominać. Potem dajemy tekst osobie nieznającej produktu i patrzymy, gdzie się zawaha. Tam dokument wymaga pracy.

To ma bezpośrednie konsekwencje dla budowy takich dokumentów. Nagłówki muszą opisywać problem czytelnika, a nie wewnętrzną nazwę funkcji, bo to je się skanuje i to one są dopasowywane przez wyszukiwarkę. Każdy krok obejmuje jedną czynność i jej widoczny efekt, żeby czytelnik mógł potwierdzić, że nadal jest na właściwej ścieżce. Ostrzeżenia stoją przed krokiem, którego dotyczą, a nie za nim. To drobiazg, który pozwala uniknąć wielu niepotrzebnych szkód. A treści dotyczące usterek układa się według objawu, bo użytkownik wie, co widzi, a nie co to spowodowało.

Nic z tego nie jest kwestią stylu. To różnica między dokumentem, który rozwiązuje problem, a takim, który zostaje porzucony w połowie.

Używamy słownictwa klienta, trzymamy krótkie zdania i wprowadzamy termin techniczny tylko wtedy, gdy naprawdę jest potrzebny, a wtedy definiujemy go raz. Jeśli jedno pojęcie ma na Twojej stronie trzy nazwy, wybieramy jedną i stosujemy ją wszędzie. Brzmi to jak drobiazg. W praktyce niespójne nazewnictwo jest jednym z częstszych powodów, dla których ludzie nie trafiają na stronę, która by im odpowiedziała.

Utrzymanie jej w ryzach to bardziej kwestia odpowiedzialności niż pisania. Pomagamy ustawić powiązanie między obszarami produktu a dokumentami, których dotyczą, żeby po każdym wydaniu było jasne, co wymaga przeglądu. Bez tego treści pomocy rozjeżdżają się w ciągu kilku wydań i nikt tego nie zauważa, dopóki nie zgłoszą tego klienci.

Z tego wynika też lista rzeczy, których potrzebujemy od Ciebie. Dostępu do produktu, najlepiej na prawdziwym koncie. Twoich zgłoszeń do wsparcia, bo to najlepsza dostępna lista tego, co trzeba opisać. I jednej osoby, która potwierdzi poprawność merytoryczną przed publikacją i pozostanie tą samą osobą przez dłuższy czas.

Warto też z góry ustalić, gdzie te treści mają mieszkać. Instrukcja w PDF-ie do pobrania jest praktycznie niewidoczna dla wyszukiwarki i niewygodna na telefonie, którym ludzie najczęściej czytają w trakcie montażu czy konfiguracji. Zwykła podstrona z porządnymi nagłówkami działa lepiej w obu tych sytuacjach i łatwiej ją poprawić po zmianie w produkcie. Jeśli PDF jest potrzebny ze względów formalnych, można mieć obie wersje, ale wersją źródłową powinna być ta, którą da się zaktualizować w minutę.