Technical Writer czyli mistrz słowa w IT

Technical Writer czyli mistrz słowa w IT

Codziennie każdy z nas ma kontakt z tekstem, czy to w postaci dokumentów, pomocy dla użytkownika, czy komunikatów na interfejsie aplikacji. Ale czy każdy tekst jest dla nas zrozumiały i łatwy w odbiorze? Nie zawsze i nie dla każdego.
W Craftware zdajemy sobie sprawę, że ktoś powinien czuwać nad poprawnością tekstów i dostarczeniem dokumentacji dobrej jakości, napisanej językiem dostosowanym do odbiorców.

Użytkownicy oprogramowania, tak jak użytkownicy każdego produktu, bywają bardzo różni. Odmienna jest ich wiedza na temat produktu, technologii, różny jest też ich poziom znajomości języka stosowanego w aplikacji. Im trudniejsza w zrozumieniu jest instrukcja, tym większe ryzyko pomyłki lub przedłużonego czasu wykonywania aktywności opisywanej przez tę instrukcję.

Nieważne, czy chodzi o 500-stronicową instrukcję użytkownika, czy też napis na przycisku. Zasada jest ta sama.

Wyobraź sobie parę przycisków w aplikacji, których nazwy powodują, że nie jesteś całkiem pewna/y, co wybrać. Na przykład takie okienko dialogowe pytające: “Are you sure you want to cancel the process?” I dające do wyboru dwa przyciski: “OK” i “Cancel”. Powiedzmy, że w tym kroku zawsze zastanawiasz się sekundę, czy dwie, co wybrać, przycisk OK, czy przycisk Cancel. Niedużo, prawda? Da się przeboleć. Dwie sekundy…

Ale co, jeśli musisz przejść przez to okienko przynajmniej raz dziennie? I jesteś jednym z 10 000 pracowników używających aplikację w firmie? Daje to ponad 1 000 roboczogodzin rocznie!

Dlatego tak ważne jest, by język używany w interfejsie użytkownika jak i w dokumentacji związanej z oprogramowaniem był jak najwyższej jakości.

Wiemy, że to przełoży się na zadowolenie użytkowników i bardziej wydajne wykorzystanie oprogramowania. Dlatego w naszych projektach korzystamy z pomocy Technical Writerów.

Ale kim właściwie jest Technical Writer?

Pisarzem

Po pierwsze jest pisarzem. Głównym zadaniem Technical Writera jest dostarczenie użytkownikowi informacji niezbędnych do poprawnego posługiwania się produktem, np. aplikacją. Pisanie to duża część pracy Tech Writera, jednak tworzenie dokumentacji to nie bezmyślne mnożenie stron tekstu. Jest to wieloaspektowy proces składający się z różnorodnych zadań.

Redaktorem

Technical Writer jest również redaktorem. Wprowadza poprawki gramatyczne, stylistyczne, leksykalne, składniowe i logiczne. Dba także o to, aby dokumenty były prawidłowo sformatowane, utrzymane w wizualnym stylu preferowanym przez firmę, oraz zgodne z wszelkimi wytycznymi, np. narzuconymi przez branżę, tak, aby cała dokumentacja stanowiła harmonijnie połączoną całość.

Tłumaczem

Tech Writer tłumaczy różne dokumenty, w tym e-maile do klientów, teksty marketingowe, czy dokumenty techniczne.

Wsparciem zespołu projektowego

Praca Technical Writera ma również jeden znaczący efekt uboczny, a mianowicie znajdowanie problemów w produkcie, który jest opisywany.

Ponieważ wielu Tech Writerów posiada wykształcenie językowe, a nie techniczne, ich interakcja z aplikacją bardziej przypomina interakcję końcowego użytkownika. To z kolei pozwala na znalezienie nieścisłości językowych w interfejsie użytkownika czy też błędów związanych z UX, zwłaszcza przy ograniczonej dostępności testerów w projekcie.

Technical Writer jest wsparciem Projektanta UX, ponieważ ma wpływ na kształt produktu poprzez proponowanie rozwiązań dla znalezionych problemów oraz zgłaszanie usprawnień. Przez wpływa na główny element swojej pracy, czyli tworzenie dokumentacji. Ponieważ usunięcie problemu w produkcie często powoduje zredukowanie liczby zagadnień, które trzeba opisać.

Bardzo często w zespole projektowym TechWriter wspomaga koordynację procesu tworzenia, recenzji i zatwierdzania dokumentów, dbając tym samym o dotrzymywanie terminów.

Podsumowując, Technical Writer jest mieszanką kilku ról w proporcjach zależnych od struktury danego zespołu i specyfiki projektu. Dostosowuje się do aktualnych potrzeb projektu i w zależności od sytuacji jest wsparciem dla:

  • analityków,
  • testerów,
  • Kierownika projektu,
  • deweloperów.

A jakie ma umiejętności?

Technical Writer to osoba, która:

  • zbiera informacje o produkcie między innymi na podstawie istniejącej dokumentacji, danych z systemu zarządzania projektami np. Jira oraz rozmów z ekspertami w danej dziedzinie,
  • przekształca programistyczny żargon na jasny, zwięzły i spójny opis,
    pilnuje terminów dostarczenia dokumentacji i przypomina o nich zespołowi,
  • dostarcza treści przystosowane do potrzeb odbiorcy, poprawne pod względem językowym. Ma to wpływ na skrócenie cykli przeglądowych i zrozumiałość dokumentacji.

 

Co więcej, Tech Writer:

  • sprawdza tekst przed publikacją lub wysłaniem do klienta,
  • tłumaczy wszelkiego rodzaju dokumenty, artykuły i prezentacje,
  • pisze spójne treści z zachowaniem zasad z podręcznika stylu oraz wszelkimi wytycznymi czy przepisami, które są narzucone np. przez branżę firmy,
  • pomaga w projektowaniu interfejsu użytkownika, tak aby produkt był jak najbardziej intuicyjny, a tym samym redukuje potrzebę maskowania niedoskonałości produktu w dokumentacji.

Podsumowanie

Rola Technical Writera w projekcie IT jest nie do przecenienia. Już wkrótce napiszemy o tym, jakie zadania warto powierzyć Tech Writerowi.

Interesuje Cię Technical Writing? Skontaktuj się z nami.