Informacja to coś czego każdy z nas potrzebuje i poszukuje. Każdy z nas - Ty przed monitorem, my w redakcji, potencjalnie każda inna osoba na świecie, również ta z niepełnosprawnością intelektualną. Jak podaje WHO, około 15% światowej populacji cierpi na jakiś rodzaj niepełnosprawności. Dlaczego o tym wspominamy?
Tworząc dokumentację powinniśmy pamiętać, że ludzie miewają problemy ze zrozumieniem czytanej treści z różnych powodów. Mogą do nich należeć zaburzenia zdolności poznawczych, niskie wykształcenie, problemy ze wzrokiem, czy czytanie tekstu w języku, który nie jest ich ojczystą mową. Aby ułatwić przyswojenie treści i jednocześnie ujednolicić standardy powstał plain language (prosty język). W oparciu o jego najważniejsze cechy opracowaliśmy listę wskazówek, które mogą być pomocne w tworzeniu dokumentacji zrozumiałej i przyjemnej w odbiorze przez każdego czytającego.
Najpierw pomyśl o odbiorcy
Poznaj czytelnika a treść będzie uszyta, a raczej napisana na jego miarę. Tylko znając potrzeby odbiorcy dokumentacji stworzymy produkt użyteczny i zrozumiały. Dlatego zanim przelejemy naszą wiedzę na papier/wirtualną kartkę naszego komputera zadajmy sobie poniższe pytania:
- Czy mój odbiorca znajdzie w dokumencie informację, której szuka?
- Czy przekaz treści jest dla czytelnika zrozumiały?
- Czy zrozumienie treści przełoży się na odpowiednie działanie (na przykład w instrukcji)?
Pisz tak, by treść łatwo było przyswoić
Any word you have to hunt for in a thesaurus is the wrong word. There are no exceptions to this rule.*
*Stephen King, "Everything You Need to Know About Writing Successfully - in Ten Minutes", 1988
Dzisiejszy świat jest w ciągłym ruchu. Ludzie cały czas gdzieś się spieszą zazwyczaj robiąc kilka rzeczy na raz. Dzięki stale towarzyszącym im tabletom, smartfonom i laptopom konsumują treść non-stop - w domu, w biurze, w kawiarni, w środkach komunikacji. Informacja ma być dostarczona tu i teraz, bez względu na warunki. Prędzej czy później, także Twoje dokumenty trafią “w teren”. Weź więc pod uwagę, że często tekst jest jedynie skanowany wzrokiem, staraj się zatem by był on jak najbardziej przejrzysty, a zdania krótkie i treściwe. Tu z pomocą może nam przyjść plain language:
-
Unikaj strony biernej. Łatwiejsze do przyswojenia jest stwierdzenie "Aby sprawdzić pocztę użytkownik musi się najpierw zalogować" niż "warunkiem sprawdzenia poczty jest wcześniejsze zalogowanie się użytkownika".
-
Staraj się by znaczenie czasowników wynikało ściśle z kontekstu.
-
Unikaj słów znanych tylko wąskiej grupie specjalistów (czyli tak zwanego technicznego żargonu), zastępując je słowami z języka potocznego gdy tylko jest to możliwe. Zamiast "impulsywnik kinetyczny" napisz po prostu "młotek" :-)
-
W miarę możliwości pisz w czasie teraźniejszym ("czerwony guzik uruchamia samodestrukcję") zamiast stosować skomplikowane konstrukcje ("naciśnięcie czerwonego przycisku spowoduje uruchomienie procedury samodestrukcji").
-
Jasno określ, kiedy coś jest wymagane. Lepiej napisać "aby się zalogować musisz podać właściwe hasło" niż "aby się zalogować powinieneś podać właściwe hasło". Słowa typu "powinien/powinna", "trzeba", "wymagane", mimo iż mają podobne znaczenie, nie oddziałują na czytelnika równie intensywnie co proste "musisz".
-
W miarę możliwości zwracaj się wprost do odbiorcy, zwłaszcza w sytuacji gdy ma on wykonywać Twoje polecenia. Instrukcja "zaloguj się by sprawdzić wiadomości" jest krótka, treściwa, nie pozostawia wątpliwości do kogo jest skierowana.
-
Ogranicz używanie skrótowców, zaś te które muszą się w tekście pojawić zdefiniuj (np. rozwijając w pełną nazwę przy pierwszym wystąpieniu). Nie popadaj jednak w przesadę, skrótów takich jak PO, PiS czy BMW raczej nie trzeba objaśniać.
-
Używaj określeń i terminów w sposób spójny. Jeśli powiążesz konkretną frazę z jakimś zjawiskiem lub problemem, używaj jej potem konsekwentnie. Przykładowo, jeśli zwrócisz się z konkretną instrukcją do Technical Writerów, nie nazywaj ich potem pisarzami, dokumentalistami, specjalistami od dokumentacji itp. Ktoś mniej zorientowany lub czytający pobieżnie może się w pewnym momencie pogubić i zastanawiać, czy np. każdy Technical Writer to pisarz albo czy jak on sam napisał w liceum wiersz dla koleżanki to jego też dotyczą polecenia 😉
-
Zachowaj hierarchię treści. Najpierw opisz mechanizmy ogólne, potem ewentualnie wyszczególnij jakieś wyjątki. Pamiętaj to wyjątek potwierdza regułę - nigdy na odwrót!
-
Nie używaj wyjątków od wyjątków. Gwarantujemy, że czytelnik się pogubi, jeżeli każesz mu zastosować się do następującej instrukcji:
-
Należy wypełnić formularz B1, chyba że w zeszłym roku przebywało się w delegacji, wtedy należy wypełnić B2 o ile delegacja nie była dłuższa niż 3 miesiące, w przeciwnej sytuacji należy wypełnić druk B3
-
Stosując proponowane reguły otrzymujemy jednoznaczne instrukcje
-
Jeżeli w zeszłym roku nie byłeś w delegacji, wypełnij formularz B1. Jeżeli byłeś w delegacji i trwała ona maksymalnie trzy miesiące - wypełnij druk B2. Jeżeli Twoja delegacja trwała dłużej niż trzy miesiące, wypełnij druk B3.
-
Posługuj się przykładami. Tak jak my w poprzednim punkcie.
-
Używaj wypunktowania gdy wypisujesz kolejne elementy z listy.
-
Wiele osób lepiej rozumie informacje gdy ma je przedstawione za pomocą obrazu, dlaczego więc nie korzystać z tego tworząc dokumentację? Użyj grafiki by zilustrować omawiane zagadnienie, a tekstu użyj jako alternatywy lub uzupełnienia. Do przekazania szerszego kontekstu można wykorzystać diagramy, animacje a nawet krótkie filmy. Wystarczy rzut oka na YouTube, by zobaczyć, że znaczna część publikowanego tam materiału to ró żnego rodzaju samouczki. Więcej o infografikach pisaliśmy tutaj.
-
Używaj nagłówków. Dłuższy tekst warto podzielić na sekcje, a tym z kolei przydzielić odpowiednie tytuły. Użyteczny nagłówek to taki, który w kilku słowach odda sens omawianej poniżej treści. Pomaga to w skanowaniu tekstu, co przyspiesza wyszukanie pożądanej informacji. Nagłówkiem może być pytanie, na które odpowiadamy w sekcji, stwierdzenie, które uzasadniamy lub temat, który poruszamy.
Spróbuj przetłumaczyć na inny język
Najczęściej dokumentację piszemy w języku angielskim, dość często wśród naszych obowiązków znajdzie się tłumaczenie na ten język. Dlaczego akurat angielski? Dlatego, że stał się on językiem międzynarodowym, nowożytną łaciną, mimo, że dla wielu jego odbiorców nie jest to język rodzimy. Większość dużych koncernów pochodzi z USA, tam też stworzono najpowszechniejsze w dzisiejszych czasach medium informacyjne - Internet. To sprawia, że mowa Shakespeare’a znalazła się w dzisiejszych czasach na mocno uprzywilejowanej pozycji. Pisząc coś w innym języku (np. po polsku) miej to na uwadze i twórz tak, by tekst dało się szybko i łatwo przetłumaczyć. Będzie to możliwe gdy zdania będą proste, a słowa przez Ciebie użyte będą posiadały swoje odpowiedniki w angielskim. W sytuacji, gdy zlecimy komuś tłumaczenie, jest spora szansa, że zapłacimy mniej, gdy tekst będzie krótszy i prostszy i gdy tłumacz nie będzie musiał korzystać ze specjalistycznych słowników. Zachęcamy w tym miejscu do przypomnienia sobie tekstów na jeden z naszych ulubionych tematów - Less is more - (klik, klik)
Rozmawiaj ze swoim odbiorcą
Jeśli to tylko możliwe spotkaj się z odbiorcą tekstu. Rozmowa twarzą w twarz sprawia, że obie strony są bardziej skoncentrowane na omawianym zagadnieniu, co prowadzi do uzyskania lepszych informacji, które z kolei łatwiej będzie nam, Technical Writerom, zebrać w sensowny i łatwy w odbiorze tekst. Jeśli piszesz instrukcję zwróć się bezpośrednio do czytelnika używając formy “ty” (wybierz, naciśnij). Zachęcamy do przypomnienia sobie dobrych praktyk przy pisaniu tego typu dokumentu - zajrzyjcie tutaj.
Zachowaj porządek
Projektując plan dokumentu postaw się w pozycji odbiorcy i ułóż opisywane sekcje w logicznej dla niego kolejności. Na początku przekaż to co jest najważniejsze z punktu widzenia czytelnika i stopniuj dalsze informacje w kolejności ich użyteczności. Pamiętaj, że wiele osób skanuje tekst, szukając w nim tylko potrzebnych informacji.
Podsumowanie
Mamy pełną świadomość, że powyższy tekst zaledwie nakreśla zagadnienie prostego języka. Zachęcamy do zapoznania się z dokumentem zaproponowanym przez wspomnianą już organizację The Plain Language Action and Information Network (PLAIN), noszącym tytuł Federal Plain Language Guidelines. Jest to zbiór reguł promowanych przez amerykańską administrację federalną i jako taki sprawdzi się w całości przede wszystkim komuś, kto pisze po angielsku. Dla nas był jedną z inspiracji przy tworzeniu ninejszego tekstu i głęboko wierzymy, że większość proponowanych rozwiązań dotyczy każdego języka. Dokument opisuje między innymi konstrukcje gramatyczne i składniowe, które są zalecane bądź odradzane, ilustrując przykładami ich właściwe i niewłaściwe użycie. Warto się z tą listą zapoznać i zastanowić, czy przypadkiem jej wykorzystanie nie wpłynęłoby korzystnie na produkowaną przez nas dokumentację.
A jak to wygląda u Was? Korzystacie z wymienionych powyżej funkcji prostego języka? A może znacie inne, wartościowe triki, które można dodać do stworzonej przez nas listy?