Zacznij od twierdzeń, które czytelnik może uznać za fakty
Przed sprawdzaniem źródeł przeczytaj szkic poradnika z perspektywy osoby, która wykona opisane kroki. Zaznacz zdania zawierające konkretne informacje: wymagania narzędzia, nazwy opcji w panelu, kolejność czynności, ograniczenia funkcji czy obietnice rezultatu. Nie każde zdanie wymaga odnośnika. Warto jednak wiedzieć, na jakiej podstawie piszesz „ta opcja jest dostępna” albo „po wykonaniu tych kroków kopia zapasowa będzie gotowa”.
Rozdziel fakty od wskazówek i przykładów. „Przycisk znajduje się w ustawieniach konta” to informacja, którą można sprawdzić. „Warto nadać mu czytelną nazwę” jest zaleceniem, które możesz uzasadnić wygodą użytkownika. Z kolei przykładowy układ menu dla małej firmy powinien być wyraźnie przedstawiony jako przykład, a nie jedyny poprawny sposób budowy strony. Taki podział pomaga zdecydować, co trzeba zweryfikować, a co lepiej doprecyzować.
Dobieraj źródło do rodzaju informacji
Jeśli opisujesz działanie systemu zarządzania treścią, zacznij od jego dokumentacji, pomocy dostępnej w narzędziu lub własnego sprawdzenia danej funkcji. Gdy tłumaczysz pojęcie, porównaj wyjaśnienia z więcej niż jednego wiarygodnego materiału i upewnij się, że dotyczą tego samego znaczenia. Materiał innego bloga może podsunąć pytania do sprawdzenia, ale samo powtórzenie zawartej w nim odpowiedzi nie jest niezależną weryfikacją.
Zwróć uwagę na zakres źródła. Instrukcja może dotyczyć innej wersji programu, planu usługi albo ustawień niż te, o których piszesz. Sprawdź także, kto odpowiada za materiał, czy pokazuje konkretne kroki i czy wyjaśnia warunki, od których zależy wynik. Brak tych informacji nie musi oznaczać błędu, ale jest sygnałem, by szukać potwierdzenia. Jeśli nie możesz ustalić, czy twierdzenie nadal obowiązuje, nie przedstawiaj go jako bezwarunkowego faktu.
Przetestuj instrukcję krok po kroku
W poradniku dotyczącym obsługi strony sama poprawność definicji nie wystarczy. Czytelnik musi jeszcze móc przejść od punktu wyjścia do rezultatu. Jeśli to możliwe, wykonaj czynności na stronie testowej lub w bezpiecznym środowisku. Zapisz, od jakiego stanu zaczynasz, jakie ustawienia są potrzebne i co powinno być widoczne po każdym ważnym kroku. Dzięki temu łatwiej wychwycisz pominięte pole, niejasną nazwę przycisku albo założenie, że użytkownik ma już odpowiednie uprawnienia.
Nie każdy autor ma dostęp do wszystkich wersji narzędzia. W takiej sytuacji ogranicz zakres poradnika i napisz wprost, czego dotyczy opis. Zamiast zapewniać, że „u każdego będzie tak samo”, wskaż, co czytelnik powinien sprawdzić u siebie. Przy działaniach, które mogą zmienić lub usunąć treści, uwzględnij bezpieczny punkt startowy, na przykład wykonanie kopii zapasowej przed większymi zmianami. Nie opisuj testu jako przeprowadzonego, jeśli opierasz się wyłącznie na cudzej instrukcji.
Popraw język tam, gdzie pewność jest ograniczona
Słowa „zawsze”, „każdy” i „wystarczy” brzmią przekonująco, lecz często ukrywają wyjątki. Po weryfikacji wróć do takich zdań i sprawdź, czy dowody rzeczywiście je uzasadniają. Zamiast „każdy formularz wyśle powiadomienie”, możesz napisać: „po skonfigurowaniu powiadomień wyślij wiadomość testową i sprawdź, czy dotarła”. Czytelnik dostaje wtedy działanie, które pozwala ocenić wynik na własnej stronie.
Gdy źródła sobie przeczą, nie wybieraj automatycznie wygodniejszej wersji. Sprawdź, czy opisują różne ustawienia lub sytuacje. Jeżeli rozbieżności nie da się wyjaśnić, usuń sporne twierdzenie, zawęź je albo wyraźnie zaznacz niepewność. To szczególnie ważne w poradnikach, do których ktoś może wrócić po dłuższym czasie. Uczciwie podany warunek jest bardziej pomocny niż stanowcza obietnica bez pokrycia.
Zrób krótką kontrolę przed publikacją i przy aktualizacji
Na koniec sprawdź tytuł, śródtytuły, podpisy ilustracji i podsumowanie. To właśnie tam łatwo pozostawić uproszczenie, którego nie ma już w treści artykułu. Przejdź również po odnośnikach: powinny prowadzić do materiału potwierdzającego konkretną informację, a ich opis powinien mówić, co czytelnik znajdzie po kliknięciu. Nie dodawaj źródeł tylko po to, by lista wyglądała na dłuższą.
Warto zachować roboczą notatkę z najważniejszymi twierdzeniami, podstawą ich sprawdzenia i elementami wymagającymi ponownej kontroli. Nie musi być rozbudowana: kilka zdań wystarczy, by po zmianie interfejsu szybko znaleźć fragmenty poradnika do poprawy. Przed ponowną publikacją przetestuj zwłaszcza kroki zależne od wyglądu panelu i usuń instrukcje, których nie możesz już potwierdzić. W ten sposób sprawdzanie faktów staje się częścią utrzymania strony, a nie jednorazowym zadaniem.
