Każdy z nas ma na co dzień do czynienia z tekstem, czy to w postaci dokumentów, instrukcji obsługi, czy komunikatów w interfejsie aplikacji. W ramach każdego projektu ktoś powinien czuwać nad poprawnością tekstów i dostarczać dokumentację wysokiej jakości, napisaną językiem dostosowanym do odbiorców. Z pomocą przychodzi profesjonalne wsparcie technical writera.
Technical writer to osoba odpowiedzialna za tworzenie, edycję i aktualizację dokumentacji technicznej np. oprogramowania lub aplikacji. Pisanie stanowi dużą część jego pracy, dlatego też głównym zadaniem technical writera jest dostarczenie użytkownikowi informacji niezbędnych do prawidłowego korzystania z danego produktu bądź systemu. Co więcej, dba o poprawność językową, gramatyczną i stylistyczną. Dokumentacja jest zawsze poprawnie sformatowana, utrzymana w preferowanym przez firmę stylu i zgodna z wszelkimi narzuconymi wytycznymi. Praca technical writera ma również jeden bardzo ważny efekt uboczny – znajdowanie problemów w opisywanym produkcie, dlatego też rola ta w projekcie informatycznym jest nie do przecenienia.
- tworzenie, weryfikacja i korekta dokumentacji projektowej
- tworzenie i aktualizowanie dokumentacji użytkownika
- dbanie o wysoką jakość językową w dokumentach projektowych
- wsparcie przy testowaniu produktów
- przygotowywanie materiałów szkoleniowych
- tłumaczenia i lokalizacja językowa
-
Zwiększenie przejrzystości komunikacji
Technical writerzy pomagają wyjaśniać skomplikowane koncepcje, przekładając żargon na prosty język z wykorzystaniem wizualizacji dzięki czemu pomagają Twojej organizacji zaspokoić potrzeby docelowych odbiorców, a tym samym zdobyć zaufanie partnerów biznesowych.
-
Zwiększenie jakości dokumentacji
Wysokiej jakości dokumentacja projektowa i użytkownika dobrze świadczy o Twojej organizacji. Dokumentacja jest zawsze logicznie uporządkowana, ze spójną terminologią i zgodna z obowiązującymi normami dokumentacji technicznej.
-
Zmniejszenie kosztów i nakładu pracy
Wysokiej jakości, dobrze napisana i przede wszystkim zrozumiała dokumentacja użytkownika pozwala zmniejszyć koszty i nakłady pracy związane z użytkowaniem i obsługą danego produktu oraz szkoleniem personelu.
-
Zwiększenie user experience
Pisarze techniczni przyjmują perspektywę użytkownika końcowego i zwracają uwagę na szczegóły. Podczas procesu tworzenia dokumentacji testują produkt, aby odkryć błędy lub problemy z użytecznością. Usunięcie tych problemów przed wypuszczeniem produktu na rynek gwarantuje, że klienci nigdy ich nie napotkają.
International Technical Communication Qualification Foundation
-
Przede wszystkim pisze. Dostarcza użytkownikowi informacji niezbędnych do poprawnego posługiwania się danym produktem. Technical writer jest również redaktorem. Wprowadza wszelkie poprawki konieczne do utrzymania wysokiej jakości dokumentacji. Tech writer tłumaczy różne dokumenty, w tym e-maile do klientów, teksty marketingowe czy dokumenty techniczne. Technical Writer jest również wsparciem dla wielu ludzi zaangażowanych w projekcie, przede wszystkim dla analityka biznesowego, project managera oraz testera. Wspiera tworzenie wszelkiego rodzaju dokumentów, począwszy od Karty Projektu poprzez URS, FS i DS aż po Deployment Plan, współtworzy skrypty testowe dla SAT i UAT, tworzy Release Notes, dokumentację użytkownika i wiele innych.
-
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. Jiry, 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
- 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 zgodne z 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
-
