Jak sprawdzić, czy artykuł rozwiązuje problem czytelnika

Przed oceną tekstu zapisz punkt wyjścia audytu:

Czytelnik: [konkretny typ osoby]. Zamiar: [co chce zrozumieć lub o czym zdecydować]. Zadanie: Po przeczytaniu potrafi [obserwowalne działanie], bez potrzeby wykonywania niewspomnianego kroku lub korzystania z niewskazanego źródła.

Na przykład:

Czytelnik: Redaktor sprawdzający praktyczny artykuł internetowy. Zamiar: Ustalić, czy tekst pomaga jego docelowemu czytelnikowi. Zadanie: Przeprowadzić audyt ścieżki wykonania zadania i uzasadnić decyzję o publikacji, poprawkach lub odrzuceniu tekstu.

To rozróżnienie ma znaczenie. „Poznać jakość treści” to temat informacyjny, a nie zadanie, które można sprawdzić. „Wskazać brakujący warunek wstępny w artykule instruktażowym i poprawić odpowiednią sekcję” to zadanie, które można sprawdzić.

Zawęź zakres tak, by wykonanie zadania miało wyraźny punkt końcowy. Poradnik może wyjaśniać, jak porównać dwa produkty, przygotować dokument, rozwiązać problem z ustawieniem lub wybrać jedną z opcji. Nie musi odpowiadać na każde powiązane pytanie, by rozwiązać opisane w nim zadanie.

Wytyczne GOV.UK dotyczące treści i publikowania zalecają określanie potrzeb użytkowników i planowanie treści z uwzględnieniem tych potrzeb. Podobne pytania zawiera samoocena Google: czy docelowi odbiorcy uznają treść za przydatną, czy czytelnicy dowiedzą się wystarczająco dużo, by osiągnąć cel, i czy zakończą lekturę z poczuciem satysfakcji (Google Search Central). To przydatne wskazówki, ale redaktor nadal musi przełożyć je na konkretny test wykonania zadania.

Wypisz po kolei czynności, które czytelnik musi wykonać, by ukończyć zadanie. Uwzględnij decyzje, obliczenia, dane wejściowe, kontrole i przekazania — nie tylko nagłówki artykułu.

Praktyczna mapa może wyglądać tak:

Następnie oznacz każdy krok jako opisany, opisany częściowo lub pominięty. „Opisany” oznacza, że czytelnik może działać na podstawie artykułu, a nie tylko że wspomniano w nim dany temat.

Na przykład artykuł o arkuszu budżetowym może wyjaśniać, jak zsumować wydatki, ale pomijać okres, który należy przyjąć, informację, czy uwzględnić podatki, albo sposób ujęcia nieregularnego rachunku. Główne obliczenie jest opisane, ale ścieżka wykonania zadania urywa się na etapie danych wejściowych.

Przydatna tabela audytu wygląda tak:

Tabela pokazuje, czy tekst jest kompletnym narzędziem. Nie pozwala też redaktorowi nagrodzić dopracowanego wstępu, przeoczając brakujący warunek wstępny.

Wiele praktycznych artykułów zawodzi jeszcze przed pierwszą instrukcją, bo zakłada wiedzę, dostęp lub warunki, których czytelnik nie ma. Przy każdym kroku zadaj cztery pytania:

Jasno określ założenia. Jeśli obliczenie wykorzystuje wartość procentową, zdefiniuj podstawę obliczeń. Jeśli poradnik konfiguracji dotyczy konkretnej wersji oprogramowania, wskaż odpowiednią wersję lub funkcję. Jeśli artykuł porównuje opcje, wyjaśnij, w jakich warunkach każda z nich jest odpowiednia.

Oddziel wymagane dane wejściowe od opcjonalnych ulepszeń. Czytelnik powinien wiedzieć, czy dany element jest niezbędny do kontynuowania, czy tylko pomocny. Umieść warunki wstępne przed procedurą, by nie dopuścić do zmarnowanego wysiłku.

Szukaj też ukrytych przekształceń. Czy czytelnik musi przeliczyć jednostki, usunąć spacje, wybrać zakres dat lub zinterpretować komunikat o błędzie? Jeśli tak, podaj regułę lub krótki przykład. Nie wymyślaj po cichu wartości dla brakujących danych wejściowych. Powiedz czytelnikowi, co ma uzyskać, jakie założenie udokumentować albo kiedy nie da się zastosować metody.

Artykuł jest bardziej wiarygodny, gdy jasno opisuje sytuacje, w których metoda zawodzi. „Jeśli wynik jest pusty, sprawdź, czy pole źródłowe zawiera dane” jest bardziej przydatne niż sugestia, że metoda zawsze działa. W audycie należy odnotować każdy punkt, w którym czytelnik może utknąć.

Przy każdym istotnym twierdzeniu zastanów się, jakiego wsparcia wymaga. Definicja może wymagać wiarygodnego źródła. Instrukcja proceduralna może wymagać podręcznika producenta lub udokumentowanej specyfikacji. Rekomendacja może wymagać określonych kryteriów i jasnego wyjaśnienia, jak prowadzą one do tej rekomendacji.

Utwórz rejestr twierdzeń z czterema kolumnami: twierdzenie, decyzja czytelnika, na którą wpływa, wykorzystane dowody oraz siła sformułowania. Ostatnia kolumna jest ważna. Dowody mogą uzasadniać stwierdzenia „może”, „zwykle” lub „jest wymagane”, ale nie automatycznie „zawsze”, „najlepsze” lub „gwarantowane”. Zachowaj warunki i ograniczenia podane w źródle.

Gdy to możliwe, wybieraj źródła oryginalne lub źródła twórców opisanej rzeczy. Na przykład wyjaśnienie W3C dotyczące kryterium WCAG 2.2 „Poziom czytelności” stwierdza, że złożony tekst powinien mieć wersję łatwiejszą do zrozumienia lub treści uzupełniające, jeśli przekracza określony poziom trudności. Redaktor może użyć tego źródła, by uzasadnić sprawdzenie złożoności tekstu, unikając niepopartego wniosku, że jeden wynik czytelności zapewnia dostępność każdego artykułu.

Dowody powinny znajdować się obok wspieranego przez nie twierdzenia, tak jak w tym przykładzie, a nie w niepowiązanej liście źródeł. Lista źródeł jest przydatna podczas recenzji, ale nie naprawi akapitu, którego sformułowania wykraczają poza dowody. Sprawdzaj daty, wersje i zakres, szczególnie w instrukcjach dotyczących oprogramowania, standardów lub zasad.

Czytelny artykuł to nie tylko przyjemna lektura; zmniejsza wysiłek potrzebny do znalezienia, zrozumienia i zastosowania instrukcji. Oceń tekst w miejscu, w którym będzie używany:

Wytyczne W3C wyjaśniają, że krótkie, powszechnie używane słowa i krótsze zdania są zazwyczaj łatwiejsze do zrozumienia, a jednocześnie wskazują, że złożona tematyka może być odpowiednia dla wyspecjalizowanych odbiorców. Oznacza to, że redakcja powinna usuwać zbędne trudności bez pozbawiania tekstu niezbędnej precyzji. Nie upraszczaj warunku, który zmienia wynik.

Używaj tabel do powtarzających się porównań, list numerowanych do sekwencji i krótkich akapitów do wyjaśnień. Jeśli krok wymaga podjęcia decyzji, umieść warunek bezpośrednio przed działaniem. Jeśli danego terminu nie da się uniknąć, objaśnij go przy pierwszym użyciu i później stosuj konsekwentnie.

Przeczytaj artykuł raz jako osoba przeglądająca treść pobieżnie, a raz jako osoba wykonująca zadanie. Czytelnik pobieżny powinien umieć wskazać obiecany rezultat, warunki wstępne i drogę do odpowiedzi. Osoba wykonująca zadanie powinna móc przejść przez kolejne kroki bez odgadywania zamierzonej przez autora kolejności.

Najlepszym sprawdzianem przed publikacją jest krótki test zadania z osobą podobną do docelowego czytelnika, która nie napisała tekstu. Podaj jej opis zadania i artykuł. Poproś, by pracowała samodzielnie, mówiąc jedynie, gdzie szuka informacji lub czego potrzebuje — nie pytaj, czy podoba jej się artykuł.

Obserwuj, czy potrafi:

Zapisuj konkretne punkty tarcia: brakujące pole, niejednoznaczną etykietę, pominięty warunek, niewyjaśniony wynik lub zewnętrzną zależność. Nie uznawaj trafnego domysłu czytelnika za dowód, że artykuł jest jasny. Zapytaj: „Co w artykule podpowiedziało ci, żeby tak zrobić?”. Jeśli odpowiedź brzmi „Już to wiedziałem”, tekst może nadal zawierać lukę.

Po teście sklasyfikuj każdy problem jako blokujący, spowalniający lub kosmetyczny. Najpierw napraw problemy blokujące: brakujące warunki wstępne, niebezpieczne niejednoznaczności, nieprawidłową kolejność i brak ścieżek obsługi wyjątków. Następnie ponownie przetestuj zmienioną ścieżkę. Test z czytelnikiem nie dowodzi uniwersalnej przydatności, ale może pokazać, czy zadanie da się wykonać komuś innemu niż autor.

Analityka może pokazać, co stało się po publikacji — na przykład wizyty, wyszukiwania, wyjścia lub interakcje — ale sama nie dowodzi, że czytelnik wykonał zadanie. Krótka wizyta może oznaczać, że odpowiedź została szybko znaleziona; długa może świadczyć o dezorientacji czytelnika. Traktuj dane o zachowaniu jako punkt wyjścia do dalszego sprawdzenia, a nie zamiennik audytu ścieżki wykonania zadania.

Jeśli masz dostęp do danych, powiąż je z konkretną hipotezą: „Czytelnicy mogą nie znajdować warunku wstępnego” albo „Ścieżka rozwiązywania problemów może być niejasna”. Sprawdź odpowiednią sekcję, powtórz test zadania i wprowadź poprawki tylko wtedy, gdy dowody je uzasadniają. Nie wyciągaj wniosków o przydatności z samej miary bez obserwacji lub innego potwierdzenia rezultatu czytelnika.

Wytyczne Google dotyczące treści tworzonych z myślą o użytkownikach zachęcają twórców do oceny jakości treści, źródeł, kompletności i tego, czy czytelnicy osiągają swój cel. Te pytania są zgodne z tym audytem, ale żaden dokument dotyczący systemu wyszukiwania nie może zagwarantować, że konkretny szkic rozwiązuje konkretne zadanie. Decyzja redakcyjna nadal opiera się na tekście, jego dowodach i zaobserwowanej ścieżce.