Technical Writer — kto to taki?

Technical Writer — kto to taki?

Jeśli kiedykolwiek interesowałeś się pisaniem technicznym, zapewne przeczytałeś już wiele artykułów opisujących, kim są technical writerzy. Odpowiedź na to pytanie nie jest oczywista, ponieważ podejścia do pracy i zakres obowiązków mogą się różnić w zależności od firmy, od projektu, a także od zakresu np. oprogramowania. 

Porozmawiajmy o roli technical writera w produkcji IT, zaletach pracy na tym stanowisku oraz wyzwaniach, z którymi trzeba się zmierzyć. Niezależnie od tego, w jakim obszarze zawodowo się poruszasz, podczas pisania nowego dokumentu musisz pamiętać o kilku typowych warunkach, tj.: 

• Odbiorcy i cel 

• Konsensus 

• Komunikacja techniczna 

• Porcjowanie informacji.

Odbiorcy i cel 

Znajomość i dokładne określenie odbiorców decyduje o trafności i jakości treści, jaką stworzysz. Podstawowe pytanie, jakie powinieneś sobie zadać, to dla kogo piszesz? Czy dla operatora linii, który nie ma czasu na zapoznanie się z Twoim rozumowaniem na temat skuteczności wizualizacji KPI? 

Czy też opisujesz funkcję dla menedżera odpowiedzialnego za podejmowanie decyzji, który nie dba o to, jak zaawansowane i inteligentne jest Twoje oprogramowanie, chyba że przejrzyście wyjaśnisz, jakie mierzalne zalety posiada. Niektórzy użytkownicy odwołują się do dokumentacji tylko po to, aby dość szybko zrozumieć, co należy zrobić , aby rozwiązać problem. 

Dlatego w dokumentach dla tych powyższych odbiorców umiejętności literackie nie odgrywają najważniejszej roli, a preferuje się zwięzłość, poglądowe screenshoty, jednoznaczność opisywanego działania, łatwy język i oczekiwany rezultat. 

Nie jest więc dobrym pomysłem marnowanie czasu na poetycką i szczegółową białą księgę dla kogoś, kto chce możliwie jak najszybciej rozwiązać problem. 

Bardziej szczegółowy opis z ilustrowanymi przykładami oraz wyjaśnienie korzyści i zastosowania produktu, funkcji jest akceptowalne, ale tylko jeśli chcesz zapoznać odbiorców z produktem lub konkretną koncepcją.

Konsensus (jednomyślne zrozumienie, jednoznaczność i spójność językowa) 

Przemysł i produkcja obfituje w złożone koncepcje i systemy, które finalnie należy rozumieć jednoznacznie. Ta złożoność naturalnie rozciąga się na IT dla produkcji. Jak mówi założyciel firmy Olsom: nie ma dwóch takich samych fabryk. Każda fabryka to unikalny ekosystem ze swoją filozofią i kulturą. Co prowadzi do różnych interpretacji podstawowych pojęć. 

Procesy w każdym zakładzie są unikalne i tworzone „na wymiar”. Musisz zrozumieć intencje i przekazać je odbiorcom w odpowiedni, klarowny sposób. Pomimo całej tej mnogości, bez względu na rodzaj tworzonego dokumentu, zawsze zmierzaj do przejrzystości treści i jak najprostszego przekazu tak, aby czytelnicy mieli jak najmniej swobody interpretowania czegoś na swój sposób. To właśnie od tego w dużej mierze zależy, czy oprogramowanie spełni oczekiwania odbiorców, jak jasno zespoły rozumieją się nawzajem i jak jednomyślnie patrzą na proces, funkcje itd.

Komunikacja techniczna 

Aby uzyskać jednoznaczność w dokumentacji, trzeba zbierać opinie oraz je analizować i porównywać. Każdy dokument ma przede wszystkim łączyć użytkowników z różnych dziedzin, którzy są zaangażowani w projekt. Owi użytkownicy operują w różnych dziedzinach, gdzie mogą mieć różne rozumienie poszczególnych treści czy celów projektu. Zadanie polega na znalezieniu wspólnego języka, który doprowadza wszystkich do wspólnego zrozumienia, rozwiewa wszelkie wątpliwość i ostatecznie do wspólnego celu. Swoistą „Biblię” projektu.

Porcjowanie informacji/model myślenia 

Produkty można porównać do konstrukcji, które składają się z różnych niezależnych sekcji, które można przestawiać na wiele sposobów, aby zapewnić wymaganą funkcjonalność. Rozbudowane i pozbawione struktury teksty nie przyciągną ani nie ułatwią poruszania się w danym systemie czy platformie, szczególnie w przypadku bardzo skomplikowanych narzędzi. Zatem warto zadbać o przejrzystą strukturę tekstu, która ułatwi użytkownikowi zrozumienie wszystkiego krok po kroku.

Rozbudowany tekst musi tworzyć logiczną i przyjemną dla oka całość. Powtarzalne i uniwersalne treści, które można wykorzystywać do kilku różnych projektów pozwolą łatwiej identyfikować problem i zaoszczędzić czas. 

Podsumowanie

Technical writer to osoba, która stara się opisywać wszystko w bardzo klarowny sposób. Powinna być po części kompetentnym i przewidującym arbitrem, a po części prawnikiem, który musi starannie dobierać słowa, których nie da się dwuznacznie zinterpretować. Wymaga to oczywiście pewnej odwagi i determinacji. Przetestuj wszystko, co możesz przetestować, zadawaj jak najwięcej pytań i nie bój się zapuszczać na niezbadane dotąd terytorium.



Avatar
Kwi 12
5 formatów rozmów kwalifikacyjnych dla inżynierów oprogramowania
Jeśli jesteś programistą, podczas poszukiwania pracy (od wczesnego do późnego etapu) możesz napotkać różne formaty rozmów kwalifikacyjnych. Przyjrzyj się im poniżej, aby wyróżnić się pośród innych kandydatów.
Mar 1
Praca w IT od zera. Junior digest, marzec 2024
Znajdziesz tu propozycje od takich gigantów jak Accenture, Google, GlobalLogic czy Luxoft, które otwierają swoje drzwi dla talentów bez doświadczenia lub z minimalnym stażem pracy.
Sty 4
Free IT Courses (Wrocław, Poland)
Free IT courses are good opportunities for young and talented specialists. Our company Synebo does the Courses a few times per year and in 2022 we did offers for 21 students.

Ta strona używa plików cookie, aby zapewnić Ci lepsze wrażenia podczas przeglądania.

Dowiedz się więcej o tym, jak używamy plików cookie i jak zmienić preferencje dotyczące plików cookie w naszej Polityka plików cookie.

Zmień ustawienia
Zapisz Akceptuj wszystkie cookies