Czy chcesz poznać wskazówki, które pomogą Ci poprawić swój technicalwriterski warsztat? Jeśli tak, to zapraszam do zapoznania się z poniższym artykułem.
To nie jest pierwszy tekst na temat tego, jak pisać lepsze treści związane z dokumentacją. Zdaję sobie jednak sprawę, że nie wszystkim chce się przeszukiwać nasze, niemałe już zasoby. Poza tym świat, który nas otacza, a wraz z nim i praca Technical Writera ulegają ciągłym zmianom, dlatego warto raz na jakiś czas odświeżać pewne informacje.
Rola(e) Technical Writera
Zanim przejdę do wskazówek, krótkie przypomnienie tego, czym zajmuje się Technical Writer i jaką pełni rolę w organizacji, dla której pracuje.
Najprościej rzecz ujmując, zadaniem Technical Writera jest przygotowanie dokumentów technicznych, które będą wykorzystywane przez organizację, pracowników, interesariuszy lub użytkowników końcowych/klientów. Dokumenty te są tworzone, by pomóc w zrozumieniu zagadnień technicznych przez nietechnicznych odbiorców. Jakie to dokumenty? O najpopularniejszych z nich przeczytacie tutaj.
Technical Writer pełni wiele ról, jednak biorąc pod uwagę biznesowy punkt widzenia, może on przyczynić się do sukcesu firmy poprzez poniższe działania:
- Skutecznie przekazuje pomysły, obserwacje, poglądy, opinie oraz sugestie. Czyni to w sposób logiczny i zrozumiały.
- Skutecznie przekazuje informacje techniczne nietechnicznej grupie docelowej.
- Używa wymaganych narzędzi i metod technicznych, aby dostarczyć odpowiednie treści.
- Tworzy raporty, prezentacje i powiązane dokumenty o określonej strukturze i właściwym zestawie słownictwa.
- Jest komunikatywny, dzięki czemu łączy interesariuszy, różnych członków zespołu, kierowników działów, itp.
- Dzięki umiejętności obserwacji i wnioskowania umie w przystępny i zrozumiały dla laika sposób przekazać treści, które są ściśle związanie z jakimś mocno technicznym tematem.
To tylko kilka przykładów umiejętności i ról, jakie musi spełnić w swej pracy Technical Writer. Jeśli jesteście ciekawi co jeszcze czeka Was w tym zawodzie, zapraszam do zapoznania się z artykułem naszego redakcyjnego kolegi: http://techwriter.pl/kapelusze-tech-writera/.
Sposoby na poprawę umiejętności pisania tekstów technicznych
Jak w każdej innej dziedzinie, tak i tu istnieją wskazówki i triki, dzięki którym możesz ulepszyć swoje umiejętności. Co więc można zrobić, by pisać lepszą dokumentację?
- Grupa docelowa Za każdym razem, gdy piszesz jakąś treść, jest ona oczywiście dla kogoś. Podobnie dla Technical Writera, pierwszym i najważniejszym krokiem powinna być identyfikacja grupy docelowej. Zawsze wskazane jest, aby być empatycznym w przekazywaniu wszelkich informacji o charakterze technicznym odbiorcom nietechnicznym.
- Poznaj swój styl Styl pisania wskazuje na cel i intencję tworzonej treści. Dodatkowo, powinien on być unikalny w taki sposób, aby przykuwał uwagę odbiorców. Jednak Tech Writer nie ma tu wolnej ręki, lecz musi przestrzegać pewnych wytycznych stylistycznych i standardów podczas pisania i projektowania treści technicznych. Pomagają mu w tym przeróżne podręczniki (np. podręcznik stylu APA, podręcznik stylu Chicago) oraz wewnętrzne wytyczne organizacji. Konkretny styl nie tylko zwiększy skuteczność dokumentu, ale także ułatwi jego interpretację oraz zapewni spójność, jeśli tworzone są różne typy dokumentacji.
- Utwórz odpowiedni zarys/szkic Na długo przed rozpoczęciem pisania docelowego dokumentu, ważne jest przemyślenie i zaplanowanie pracy nad nim. Posiadanie zarysu/szkicu będzie stanowiło mocną podstawę przy tworzeniu ostatecznej wersji dokumentu. Będzie także pomocne w zaplanowaniu pracy oraz przy etapie zbierania niezbędnych informacji (research, rozmowy z ekspertami itp.).
- Zdefiniuj swoje zadanie Po stworzeniu wstępnego szkicu tego, jak powinna wyglądać Twoja treść, następnym krokiem jest zdefiniowanie samego projektu. Na każdym etapie, od zebrania danych do ostatecznego wyniku, wymaga to od Technical Writera pewnej dozy dyscypliny. Można swój cel osiągnąć, definiując każdy krok indywidualnie, jasno i konkretnie.
- Użyj prostego i jasnego języka Głównym celem tworzenia dokumentacji technicznej jest przekazanie informacji w prosty i nieskomplikowany sposób. Zrównoważony i jednoznaczny język to sedno tego typu pisarstwa. Wiadomość musi być dostarczona w możliwie najbardziej bezpośredni sposób, bez niespodzianek czy dwuznaczności. Nie ma potrzeby używania dopracowanego słownictwa na wysokim poziomie, aby zadowolić odbiorców. Krótkie i zwięzłe zdania stanowią tu podstawę. Pamiętaj: „Prostota to największe wyrafinowanie”.
- Unikaj języka dyskryminacji lub dyskomfortu Niezwykle ważne jest zwrócenie uwagi na język używany w komunikacji pisemnej. Należy unikać dialektu, który ma negatywne znaczenie lub który może okazać się dyskryminujący. Technical Writer w żadnym wypadku w nie może wywoływać uczuć wściekłości, nienawiści lub niesprawiedliwości w umysłach czytelnika. Jak każda pisemna forma dokumentu, także dokumentacja techniczna jest uważana za autentyczny dowód w świetle prawa.
- Wybierz właściwe słowa Słowa odgrywają dominującą rolę w sztuce pisania, także technicznego. Dobór odpowiednich słów w odpowiedniej kolejności nie tylko przykuwa uwagę czytelnika, ale na dłuższą metę zwiększa jego zaangażowanie. Niektóre słowa odzwierciedlają siłę i zapał. Niektóre mogą być nudne i słabe, a niektóre mogą wpaść w różne bieguny ekstremalności. Sprytny Technical Writer będzie wiedział, jak bawić się słowami o różnej naturze w najlepszy możliwy sposób. Będzie też wiedział jakich słów użyć, by dokumentacja techniczna była zrozumiała i przystępna w odbiorze nawet dla całkowitego laika.
- Krótkie zdania i krótkie słowa Pisanie dokumentacji technicznej nie polega na pisaniu epopei. Chodzi o to, aby przekaz był jak najbardziej zwięzły i skuteczny. Można to osiągnąć, używając właściwych słów, które są krótkie, znajome i należą do języka globalnego. Nie ma potrzeby owijania w bawełnę ani używania przenośni. Synonimy pojedynczego słowa mogą się różnić, gdy są używane w innym kontekście, dlatego należy ich unikać.
- Użyj strony czynnej czasownika Musisz pamiętać, że używanie odpowiedniej konstrukcji zdania może wywrzeć wielki wpływ i pozytywne wrażenie w umysłach odbiorców. Użycie czynnej strony czasownika sprawia, że treść jest bardziej dynamiczna i przyjemna. Jest to również prosta sztuczka, która eliminuje niepotrzebne słowa lub działania.
- Przytocz odpowiednie przykłady Zawsze lepiej jest poprzeć treść, cytując dobre i trafne przykłady, referencje i niezbędne statystyki. Ta technika z pewnością pomoże Ci w realistycznym opisaniu tematu. Może również okazać się świetnym sposobem na rozwiązanie potencjalnych problemów, które mogą pojawić się w przyszłości.
- Wykorzystaj moc wizualizacji Wykresy i wizualizacje to genialny sposób na ustanowienie silnego połączenia między czytelnikiem a treścią. Istnieje wiele typów dokumentów, które można ulepszyć poprzez dodanie screenshotów, wizualizacji, wykresów itp. Jednak pamiętaj, że wizualizacje to wartość dodana dla prezentowanej treści i nie można nią zastąpić istotnych fragmentów tekstu.
- Popraw i edytuj Jest to podstawowa zasada, która ma zastosowanie dla wszystkich form pisania i pracy literackiej, a nie ogranicza się tylko do pisania dokumentacji technicznej. Żadna treść nie jest idealna za pierwszym razem. Aby dzieło było bezbłędne i atrakcyjne zawsze wymaga pewnych poprawek, edycji, usunięć czy wtrąceń. Weryfikacja i korekta poprawności pisowni, interpunkcji, składni, języka, dykcji, formatowania itp. to tylko niektóre z podstaw, którymi musisz się zająć w pracy Technical Writera. Jest to konieczne, aby Twoja treść była spójna i służyła określonym. w projekcie celom. Dobrą praktyką jest pokazanie kompletnej wersji tekstu komuś, kto spojrzy "świeżym okiem" i dokona korekty tekstu.
- Nawiązywanie kontaktów biznesowych W pracy Technical Writera równie ważne, co tworzenie dobrej treści, są relacje z osobami pracującymi nad opisywanym przez nas produktem. To dzięki nim uzyskujemy niezbędne informacje, które później wykorzystamy podczas pisania dokumentacji. Jedną z ważnych cech dobrej treści technicznej jest wypełnienie luki poprzez przekazanie koncepcji i aspektów technicznych odbiorcom, którzy mogą, ale nie muszą, posiadać odpowiedniej wiedzy. Jest to możliwe tylko wtedy, gdy istnieje dobra relacja między zespołem Tech Writerów, a innymi osobami zaangażowanymi w projekt.
- Gruntowna wiedza na dany temat Kolejnym ważnym aspektem jest znajomość tematu, o którym będziesz pisać. Nie musisz być jednak ekspertem. Ważne, byś rozumiał o czym piszesz, a w razie problemu, że znajdziesz kogoś, kto zna temat lepiej i wyjaśni Ci wątpliwości. Oczywiście zebranie informacji wymaga dodatkowego wysiłku, ale staje się obowiązkowe dla zapewnienia wysokiej jakości dokumentacji.
- Bądź uczniem tego rzemiosła Możesz mieć wrażenie, że jesteś ekspertem w dziedzinie pisania dokumentacji technicznej, jednak zawsze znajdzie się coś, co można ulepszyć. Pamiętaj, że świat technologii ciągle się zmienia, pojawiają się nowe koncepcje, narzędzia czy sposoby na przekazanie informacji. Warto trzymać rękę na pulsie, uczyć się tego, co nowe na rynku, by wraz z doświadczeniem, budować solidny fundament własnej kariery i odnosić kolejne zawodowe sukcesy. Czego oczywiście serdecznie Wam życzę 😉
Powyższe praktyki to coś z czego możecie, ale nie musicie korzystać. Są one na tyle uniwersalne, że można zastosować je nie tylko w pracy Technical Writera, ale także w tworzeniu innych treści.