Przy tworzeniu nowych aplikacji, portali, programów komputerowych, sprzętu AGD, specjalistycznych maszyn,… jedną z ważnych kwestii jest przygotowanie dokumentacji związanej z nowym produktem, takiej jak instrukcje instalacji, pomoc kontekstowa, procedury wewnętrzne, dokumentacja dla programistów i testerów, materiały szkoleniowe, a także jasnych i zrozumiałych instrukcji dla użytkowników końcowych. Zajmuje się tym ktoś taki, jak ja, czyli redaktor dokumentacji technicznej, po angielsku zwany technical writer.

---

Moim zadaniem jest napisanie wszystkich komunikatów, których użytkownik potrzebuje do efektywnego korzystania z naszego produktu. Dbam nie tylko o to, żeby instrukcje, napisy na przyciskach i oknach dialogowych oraz teksty marketingowe, dokumenty techniczne, infografiki, treść stron internetowych lub e-maile wysyłane do klientów były zrozumiałe, ale też żeby były napisane poprawną polszczyzną. 

---

Moja praca jest potrzebna, bo żeby użytkownicy byli zadowoleni z naszego produktu, chętnie z niego korzystali i polecali go innym, muszą łatwo nauczyć się jego obsługi, a używanie go nie powinno sprawiać im problemów. W przypadku urządzeń technicznych instrukcje powinny być proste, a każdy etap pracy wyjaśniony po kolei w sposób, który utrudnia, a najlepiej uniemożliwia, błędną obsługę. Dla produktów z branży IT ważne są np. przyciski w aplikacji, których nazwy bywają tak mylące, że użytkownik nie jest pewny, co powinien kliknąć, żeby wykonać konkretną operację. Np. okno dialogowe z pytaniem \"Czy chcesz zakończyć tę operację?\" i przyciskami \"Tak\" oraz \"Zakończ\". 

---

Przekształcam specyficzny język techniczny w jasny i zwięzły i komunikat dla końcowego użytkownika. Dlatego podczas spisywania instrukcji obsługi programu czy urządzenia sam je obsługuję i sprawdzam działanie wszystkich jego funkcji. Dzięki temu mogę znaleźć błędy, których wcześniej nie zauważono, i zaproponować ich rozwiązanie. Zbieram też informacje na jego temat dostępne w istniejących roboczych dokumentach, w systemach zarządzania projektami, zdobywam je też podczas rozmów z zespołem programistów, konstruktorów, projektantów. 

---

Pilnuję dotrzymywania ustalonych terminów dostarczania dokumentacji, zajmuję się też dbaniem o to, żeby wszystkie dokumenty, które powstają w naszej firmie, były właściwie sformatowane, zawierały nasze logo, odpowiednią czcionkę oraz były zgodne z wytycznymi, jakie obowiązują w naszej branży. 

---

Co powinienem umieć? 

Muszę biegle posługiwać się językiem angielskim, ponieważ to oficjalny język, w jakim opracowuje się dokumentację produktów z wielu branż, a programy komputerowe, których używam podczas pracy, często mają angielski interface. Bez znajomości tego języka nie mógłbym też sprawnie tłumaczyć anglojęzycznych instrukcji obsługi i innych dokumentów na język polski. 

---

Muszę świetnie znać polszczyznę i potrafić się nią posługiwać, umieć pisać teksty jasne, przejrzyste i zrozumiałe dla użytkowników, bez literówek, błędów gramatycznych, stylistycznych, leksykalnych,…

---

W mojej pracy bardzo ważna jest znajomość programów komputerowych i narzędzi ułatwiających tworzenie dokumentacji technicznej, np. standardu Markdown, HTML, CSS, JavaScript, programów graficznych i CAD oraz przynajmniej jednego języka programowania, np. Python. Powinienem też posługiwać się programami do wspomagania tłumaczeń, np. memoQ, Trados, bo znacząco ułatwiają mi pracę. 

---

Jakie kompetencje miękkie są ważne w mojej pracy? 

• kreatywność,
• komunikatywność,
• bardzo dobra organizacja własnej pracy,
• dokładność,
• umiejętność pracy pod presją czasu,
• spostrzegawczość,
• umiejętność pracy w zespole,
• dociekliwość.

---

Gdzie mogę pracować? 

Mogę znaleźć zatrudnienie w najróżniejszych firmach, w tym z branży IT, motoryzacyjnej, AGD, RTV, militarnej, lotniczej,… - wszędzie tam, gdzie tworzy się produkty, do których trzeba dołączyć jasne i zrozumiałe instrukcje ich użytkowania.