Kilka pytań do – część 1

Jak powszechnie wiadomo, jednym z najlepszych źródeł wiedzy jest doświadczenie innych osób. Dlatego też poprosiliśmy naszych czytelników, żeby opowiedzieli nam trochę o sobie i o swojej pracy z dokumentacją. To czego się dowiedzieliśmy przekazujemy dalej z nadzieją, że będzie to dla Was bezcenna wiedza, którą spożytkujecie najlepiej jak to możliwe.

Nasz nowy cykl otwiera Ola, która od kilku lat tworzy dokumentację w firmie zajmującej się rozwijaniem programów księgowych. To tyle słowem wstępu, zapraszamy do lektury.

Jak długo pracujesz jako Tech Writer?

Prawie 3 lata.

W jaki sposób zostałaś Tech Writerem?

Skończyłam studia na Politechnice Warszawskiej na wydziale Mechatronika, kierunek Mechanika i Budowa Maszyn, specjalizacja Mikromechanika. Dość szybko doszłam jednak do wniosku, że pracy jako konstruktor w Warszawie łatwo nie znajdę.

Jeszcze na studiach pracowałam w firmie sprzedającej oprogramowanie dla konstruktorów, najpierw jako handlowiec, a później jako specjalista ds. technicznych, czyli po prostu helpdesk. Na tym drugim stanowisku szykowałam materiały szkoleniowe dla klientów, pisałam „reklamówki” na stronę internetową, napisałam raz artykuł reklamowy do gazety. W wyniku kadrowych problemów w firmie, zostałam ponownie przeniesiona na stanowisko handlowca, co dość mocno kłóciło się z moją wizją rozwoju zawodowego. Nieśpiesznie zaczęłam się rozglądać za nową pracą i szukać pomysłu na siebie.

Zaaplikowałam na stanowisko technical writera i ku mojej wielkiej radości zostałam przyjęta, będąc głęboko przekonana, że to jest to, czego szukam. Nie pomyliłam się.

Na pewno w przyjęciu do pracy pomogło mi to, że słowo pisane i dbałość o język, styl i edycję tekstu, nie jest mi obce od dawna. Pisałam artykuły do gazet szkolnych, zajmowałam się korektą tekstów znajomych i mojej Mamy. W pierwszej pracy dość szybko wszystkie oficjalne teksty i ulotki promocyjne zaczęły być kierowane do mnie w celu sprawdzenia poprawności.

Czy możesz opowiedzieć coś o swojej firmie i zespole, w którym pracujesz?

Pracuję w dziale produkcji oprogramowania, gdzie tworzymy i utrzymujemy programy księgowe. Dział liczy 20 osób i jest podzielony na 4 zespoły. Początkowo nie byłam przypisana do konkretnego zespołu, pracowałam „ponad podziałami”. Przez dwa miesiące byłam związana z zespołem, którego zadania najbardziej pokrywały się z moimi.

W jakis sposób jest zorganizowana praca Twoja i Twojego zespołu?

Zespoły pracują w lekko zmodyfikowanym scrumie.
Moim zadaniem było stworzenie całkiem nowej, nowoczesnej instrukcji do istniejącego programu, a także uzupełnianie jej o informacje dotyczące nowych funkcji. Po pół roku udało mi się wywalczyć porzucenie utrzymywania przy użyciu starej dokumentacji, która nie przystawała do współczesnych standardów i była tak długo nieaktualizowana, że jakakolwiek aktualizacja wyglądała na czyn karkołomny. Product ownerzy z działu, w porozumieniu z działem serwisu, wyłaniali partiami tematy, które należało opisać w pierwszej kolejności. Moja praca nie była połączona z pracą programistów, którzy pracowali nad innymi funkcjami niż te opisywane przeze mnie.

Obecnie zostałam na stałe włączona do zespołu pracującego nad nową aplikacją, jednak wykonuję zadania dla wszystkich.

Jakich narzędzi używasz i co o nich sądzisz?

Korzystam z Confluenca. Nie mam do niego jakichś wielkich uwag. Prosty w obsłudze, łatwo wprowadzać zmiany. Czasem niektóre elementy graficzno – edycyjne zachowują się z sposób niezrozumiały, ale można nauczyć się z tym żyć.

W jaki sposób zdobywasz informacje potrzebne do tworzenia dokumentacji?

Wiadomości merytoryczne (księgowo – kadrowe, produkcyjne, sprzedażowe) czerpałam z internetu i od product ownerów, którzy są niesamowitymi specjalistami, chętnymi do dzielenia się wiedzą w zrozumiały dla mnie sposób. Czasem szukałam pomocy u znajomych księgowych.

Czystą obsługę programu zawsze najpierw próbuję opanować sama, chyba że temat jest wyjątkowo trudny. W przypadku wątpliwości pomagają mi w pierwszej kolejności product ownerzy, potem programiści.

Jakie dokumenty dostarczasz, w jakiej postaci, w jakim języku/językach i jak są one publikowane?

Instrukcja jest dostępna online. Ja piszę bezpośrednio w Confluence i mam stałą kontrolę nad wyglądem i formą tekstu. Piszę tylko po polsku, programy, które opisuję są skierowane tylko do polskich odbiorców.

Jakie produkty opisujesz?

Program księgowy RAKS SQL, program dla samodzielnych przedsiębiorców TAXEON (w ramach oddzielnej pracy)

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?

Tak, ostatnio w ramach promocji nowego programu zajmowałam się edytowaniem i sprawdzaniem poprawności tekstów znajdujących się w programie i na stronie go promującej oraz maili skierowanych do użytkowników. Robiłam także filmy reklamowe, znajdujące się na stronie, korzystając z programu Camtasia. Jeśli poprawiam lub piszę teksty, które potem programiści wprowadzają bezpośrednio do programu, to dostarczam je im w zwykłym doc-u.

Jakie są największe wyzwania, które napotykasz w swojej pracy?

Przełamanie strachu pytania o wszystko. Pogodzenie się z tym, że w momencie kiedy siadam do nowego tematu nie mam o nim zielonego pojęcia (to nawet przekułam w zaletę i bardzo lubię dowiadywać się coraz to nowych rzeczy). Wyzwaniem też było nauczyć się odbierać uwagi i poprawki od innych osób, nie zawsze kompetentnych i „uprawnionych” do dawania uwag.

Co najbardziej lubisz w pracy Tech Writera?

Samodzielność. U mnie w firmie mam praktycznie nieograniczoną władzę nad moją (tak o niej myślę) dokumentacją. Spokój (na ogół nie gonią mnie terminy). Zdobywanie ciekawych informacji.

Co byś radziła osobom, które chciałyby zacząć swoją przygodę z pisaniem dokumentacji?

Jeśli są językowymi pedantami – niech się nie wahają!
W zasadzie podpisuję się pod wszystkimi radami, jakie dają guru od technical writingu. W tej pracy nie jest za bardzo ważne wykształcenie, choć na pewno może więcej pomóc niż zaszkodzić. Fakt, że ja mam wykształcenie techniczne sprawia, że łatwiej jest mi się dogadać z programistami i jeśli przyszłoby mi opisywać produkt bardziej techniczny – znacznie szybciej bym go zrozumiała. Dużo jednak zależy jaki produkt i dla jakiego użytkownika opisujemy. Jeśli ma to być instrukcja obsługi samolotu, to pewnie jednak dobrze by było być specjalistą z zakresu lotnictwa.
To co mi się wydaje najważniejsze, to chcąc być technical writerem trzeba sobie uczciwie odpowiedzieć na pytanie czy dba się o szczegóły: językowo, stylistycznie i edycyjnie. Trzeba też się nastawić na to, że w początkowej fazie każdego projektu nic się nie wie. To chyba stanowi o możliwości napisania dobrej dokumentacji – startujesz z tego samego poziomu wiedzy co użytkownik. Dzięki temu łatwiej się wczuć w jego wątpliwości, problemy i sposób myślenia.

Jeśli chcecie skontakować się z Olą albo sami macie ochotę podzielić się swoimi doświadczeniami, nie zwlekajcie dłużej tylko piszcie na adres kontakt@techwriter.pl.