W kolejnej odsłonie naszego cyklu gościmy Tomka Prusa, jednego ze starych wyjadaczy polskiego tech commu. Być może znacie już Tomka z tegorocznej konferencji soap!, gdzie był jednym z prelegentów, lub z zaangażowania w społeczność MeetContentWRO. Tak czy inaczej, zróbcie sobie kawę i rozsiądźcie się wygodnie, bo jest co czytać. 😊
Jak długo pracujesz jako Tech Writer?
Z dokumentacją techniczną związany jestem osiem lat. Przez pięć lat pracowałem jako Tech Writer. Obecnie jestem managerem działu dokumentacji i większość czasu zajmują mi głównie kwestie organizacyjne i koordynacyjne.
W jaki sposób zostałeś Tech Writerem?
Przez przypadek. Ukończyłem Wydział Elektroniki i Telekomunikacji na Politechnice Wrocławskiej i rozpocząłem pracę w dziale rozwoju oprogramowania LG Electronics. Nieoczekiwanie dostałem propozycję od znajomego do wzięcia udziału w rekrutacji na stanowisko Documentation Engineer w firmie Nokia Siemens Networks. Chęć zdobywania wiedzy z branży telekomunikacyjnej była na tyle duża, że zdecydowałem się zaaplikować i udało się. Zostałem Tech Writerem w fantastycznym zespole, który uczył się rzemiosła pisarskiego od bardziej doświadczonych kolegów z Finlandii i Niemiec.
Czy możesz opowiedzieć coś o swojej firmie i zespole, w którym pracujesz?
Obecnie pracuję we wrocławskim oddziale Unit4. Moja firma to międzynarodowa korporacja zajmująca się tworzeniem oprogramowania klasy enterprise (ERP) dla przedsiębiorstw oraz instytucji publicznych. Polski oddział liczy ok. pięćset osób. Ja zarządzam wirtualnym zespołem kilkunastu Tech Writerów z Polski, Hiszpanii, Wielkiej Brytanii i USA. Mój zespół to mieszanka doświadczenia i świeżości.
W jaki sposób jest zorganizowana praca Twoja i Twojego zespołu?
Moja firma pracuje w Agile'u, a Technical Writerzy są członkami zespołów scrumowych. Każdy Tech Writer wspiera 2-4 zespoły dokumentując różne produkty i funkcjonalności w 2-3 tygodniowych sprintach. Jednocześnie wszyscy Technical Writerzy należą do jednego zespołu dokumentacyjnego i raportują bezpośrednio do mnie. Pozwala to na szybsze reagowanie na problemy Tech Writerów, którzy jakby nie było, mają nieco inne zadania niż reszta Scrum teamu. Bycie w jednym zespole to również zaleta (czasami i wada 😉) posiadania swojego budżetu. Jako manager dokumentacji pełnię także w niektórych projektach rolę project managera i koordynatora tłumaczeń.
Jakich narzędzi używasz i co o nich sądzisz?
Do tworzenia treści obecnie używam MadCap Flare'a, który jest "spięty" z Microsoft Team Foundation Serverem (TFS) - systemem kontroli wersji. Flare pozwala generować nam różne outputy i kontrolować "look and feel" dokumentów. Do naszych potrzeb projektowych sprawdza się bardzo dobrze. Czasami narzekamy na stabilność i szybkość działania, ale ogólnie rzecz biorąc, jesteśmy zadowoleni. Część wewnętrznych projektów tworzona jest w markdownie. Większość tworzonej przez nas dokumentacji to Online Help zintegrowany z softwarem i dostępny na środowiskach testowych, do których mamy ciągły dostęp. Do śledzenia postępu prac projektowych służy nam TFS. Zawartość TFSa wyświetlamy za pomocą przeglądarki lub Visual Studio - dla mnie super sprawa, bo wszystko jest w jednym miejscu i często za pomocą jednego zapytania jestem w stanie sprawdzić status prac projektowych. Do komunikacji w firmie używamy Sharepointa, yammera, Slacka, Skype'a, go2meeting i video konferencji. Czasami ta dowolność jest wręcz zbyt duża, ale pozwala ona na dostosowanie się do różnych sposobów pracy ludzi, z którymi współpracujemy.
W jaki sposób zdobywasz informacje potrzebne do tworzenia dokumentacji?
Tak jak wspomniałem, pracujemy w Agile'u. Tech Writerzy siedzą z zespołami i zdobywają informacje bezpośrednio od nich. Uczestniczą w planowaniach sprintów, często pojawiają się na daily stand-upach. Głównym źródłem informacji są Analitycy Biznesowi, którzy mają szeroką wiedzę produktową. Często większość potrzebnych informacji wprowadzana jest do tasków w TFSie przez Scrum masterów (lub przypisanych do tego zadania innych członków zespołów), co zdecydowanie skraca czas pracy Tech Writerów. Jako manager uczestniczę w Product Steering Grupach, skąd zdobywam najważniejsze informacje dotyczące planowania. Na tych spotkaniach mam wpływ na decyzje podejmowane przez najważniejsze osoby w projekcie (Release Managera, Product Managera, Managerów R&D).
...a tak po ludzku, to trzeba budować sieć kontaktów i trzymać sztamę z SMEs i Release Managerami 😊 Ja często przyjmuję zasadę: "ja pomogę Tobie, ale Ty pomożesz mi" - u mnie działa.
Jakie dokumenty dostarczasz, w jakiej postaci, w jakim języku/językach i jak są one publikowane?
Dostarczamy głównie Online Help w wersji HTML-owej oraz zestaw Release Notesów i Reference Manuali w wersji PDF (publikowane na portalu klienckim). Technical Writerzy z mojego zespołu tworzą dokumentację w języku angielskim (en-GB lub en-US), która jest tłumaczona przez zewnętrzną firmę na kilka innych języków. Tech Writerzy współtworzą także UI stringi (teksty, które pojawiają się na interfejsie użytkownika). UI stringi tłumaczymy na kilkanaście języków. Ciekawostką jest fakt, że Technical Writerzy z mojego zespołu współtworzą również dialogi dla naszego korporacyjnego chatbota - Wandy.
Jakie produkty opisujesz?
Dokumentujemy kilka produktów klasy ERP o globalnym zasięgu. Jest to oprogramowanie dostarczane w chmurze, bądź na środowiskach klienta. Trzeba przyznać, że dość skomplikowane i niezwykle skalowalne. Powoduje to potrzebę bardzo dokładnego opisywania nie tylko procedur, ale także opisów funkcjonalności, czy samego interfejsu. Warto dodać, że nasze oprogramowanie jest tworzone dla użytkownika końcowego, ale dokumentacja jest również używana przez wewnętrznych i zewnętrznych konsultantów wdrożeniowych. Z uwagi na to definiowanie odbiorcy bardzo często jest utrudnione.
Czy oprócz tworzenia dokumentacji zajmujesz się czymś jeszcze, np. tworzeniem materiałów marketingowych? Jeśli tak, to czym i jakich narzędzi do tego używasz?
Nie. Firma posiada osobny zespół ludzi zajmujący się marketingiem i osobny dział tworzący szkolenia.
Jakie są największe wyzwania, które napotykasz w swojej pracy?
Jako Tech Writer często spotykałem się z problemem dokumentowania produktów, które nie były skończone, lub nie działały jak powinny. Obecnie olbrzymim wyzwaniem jest tłumaczenie dokumentacji i współpraca z firmami dostarczającymi tłumaczenia. Nie będę chyba zbyt oryginalny mówiąc, że problemem jest także zbyt mała ilość Tech Writerów w firmie i zbyt duży zakres prac. Nie ukrywam, że dotyka brak kontaktu z klientami. Jako spore wyzwanie traktuję także mierzenie efektywności pracy Tech Writerów i liczbowe podejście do jakości wytwarzanej dokumentacji.
Co najbardziej lubisz w pracy Tech Writera?
To, że nigdy się nie nudzę. Jak mówi cytat z Forresta Gumpa: "Życie jest jak pudełko czekoladek, nigdy nie wiesz co ci się trafi...". Każdy dzień potrafi przynieść nowe wyzwania i niespodzianki, co daje niesamowitą możliwość uczenia się. Lubię Tech Writing, bo wpasowuje się w moją detektywistyczną naturę. Szukanie rozwiązania problemu sprawia mi niezmierną radość. Praca z Tech Writerami daje mi również możliwość spotkania wspaniałych, ciekawych i nietuzinkowych ludzi, co dla mnie jest wartością nie do przecenienia.
Co byś radził osobom, które chciałyby zacząć swoją przygodę z pisaniem dokumentacji?
Żeby spróbowali. Pojawia się coraz więcej nowych ofert, wzrasta świadomość roli Tech Writera. Jeśli władasz angielskim i masz wrodzoną ciekawość - moim zdaniem to już połowa sukcesu. Tech Writerów z doświadczeniem jest nadal w Polsce mało, więc firmy same decydują się na ich wyszkolenie.
Dla rozpoczynających przygodę z Tech Writingiem polecam szkolenie ITCQF - International Technical Communication Qualifications Foundation, które jest świetną podstawą do wkroczenia w świat komunikacji technicznej.
Jeśli nie wiesz jak zacząć, to przyjedź na konferencję soap! do Krakowa lub wpadnij na MeetContent do Krakowa lub Wrocławia. W internecie aż roi się od darmowych materiałów. Warto poczytać stronę Techwriter.pl, zapisać się do grupy Tworzenie dokumentacji na Facebooku lub dołączyć do kanału Write the Docs na Slack'u.
Możliwości jest wiele. Ja zachęcam wszystkich zainteresowanych. Społeczność TechComm czeka na Was!
W razie dodatkowych pytań możecie skontaktować się z Tomkiem bezpośrednio przez e-mail prus.tomek@gmail.com. Jeśli macie ochotę podzielić się swoimi doświadczeniami, nie zwlekajcie dłużej, tylko piszcie na kontakt@techwriter.pl.
Zdjęcie: Nik MacMillan (Unsplash)