Perły z sylabusa ITCQF – najciekawsze fragmenty

W dzisiejszym artykule znajdziecie kilka perełek pochodzących z sylabusa ITCQF wraz z komentarzami na ich temat. Liczę, że po ich przeczytaniu zechcecie sięgnąć po cały tekst źródłowy ;).

Czytanie dokumentacji nie stanowi zbyt częstej i pasjonującej lektury. Najczęściej sięgamy po nią dopiero wtedy, gdy problem z obsługą okazuje się znaczny i, mimo wrodzonej intuicji połączonej z niebywałą inteligencją, nie dajemy rady zmusić danej aplikacji lub urządzenia do współpracy. Poziom frustracji rośnie, podczas gdy usiłujemy odnaleźć odpowiedni, w danej sytuacji, fragment tekstu. Nawet jeśli dokumentacja jest dobra, często nie udaje się od razu odgadnąć, w którym miejscu autor postanowił zawrzeć kluczowe dla nas wskazówki. Tematyka bywa zagmatwana i zawiła, a rozczytywanie tych informacji wymaga dużego samozaparcia i koncentracji.

Dokumentacja to zbiór tekstów o przeznaczeniu użytkowym i wiadomo, że nie czyta się ich dla przyjemności. Z jakim więc nastawieniem można usiąść do lektury opisu zakresu tematów na potrzeby certyfikatu ITCQF? Sam sylabus to w gruncie rzeczy „dokumentacja standardu tworzenia dokumentacji”, opis procedur i zaleceń mających dać obraz tego czym jest komunikacja techniczna. Pół biedy, jeśli jesteś świeżym narybkiem w branży, ale co, jeśli masz już wieloletnie doświadczenie? Po co czytać opis praktyk dokumentacyjnych, jeśli masz już własne metody i znasz specyfikę tego fachu?

Otóż… można się pozytywnie zaskoczyć! Lektura w wielu miejscach okazuje się odkrywcza i daje do myślenia. Kolejne akapity pomagają zwerbalizować kwestie, których możesz mieć świadomość, ale które być może po raz pierwszy widzisz w tak uporządkowanej formie. W poniższym artykule przytaczam kilka moich ulubionych fragmentów z krótkimi komentarzami. W tekście zawarłem tłumaczenia mojego autorstwa.

 

Sekcja 1.2: Wartość biznesowa komunikacji technicznej

Technical communication, as a part of product development process has a great influence on the way an organization is perceived by customers and partners. A well-documented product delivered together with comprehensive training materials is more attractive to many customers, as it usually implies reducing cost and effort required for product implementation, usage and maintenance, as well as for staff training. Also, an organization that can afford providing such deliverables as part of a clearly documented process and according to recognized standards is more likely to gain the trust of possible business partners; therefore, technical communication may be successfully used as a valuable marketing tool.


Komunikacja techniczna, będąca częścią procesu rozwoju produktu, ma wielki wpływ na to, jak organizacja odbierana jest przez klientów i partnerów biznesowych. Dobrze udokumentowany produkt dostarczony wraz z kompleksowymi materiałami szkoleniowymi jest bardziej atrakcyjny dla klientów z racji redukcji kosztów i mniejszego wysiłku potrzebnego na wdrożenie, obsługę i utrzymanie produktu w dobrym stanie; nakłady na szkolenia pracownicze okazują się mniejsze. Organizacja potrafiąca dostarczyć takie materiały w ramach dobrze opisanej procedury bazującej na uznanych standardach ma większe szanse na zdobycie zaufania partnerów biznesowych, dlatego komunikacja techniczna może być skutecznie stosowana jako cenne narzędzie marketingowe.

Myślę, że znajdzie się wiele osób w branży, które miały problem z odpowiedzią na pytanie, jak dokumentacja wpisuje się w szerszy obraz firmy. W odróżnieniu od działów bezpośrednio zaangażowanych w tworzenie produktu, wartość biznesowa działu dokumentacji bywa trudna do uchwycenia i zaprezentowania. Powyższy akapit dobrze podsumowuje niektóre z korzyści, jakie płyną z inwestowania w dokumentację na odpowiednim poziomie.

 

Sekcja 1.4: Psychologiczny aspekt komunikacji technicznej

It lies in the writers’ best interest to ensure a successful interaction and a constructive flow of information with product developers, testers, subject matter experts, as well as high management representatives. The most valuable assets that help achieve this goal include consistency and curiosity, as well as empathy in reference to peers and the audience. Most importantly, writers need to spread the awareness that all the persons involved in collaboration are pursuing a common goal, that is, the success of their project.


W najlepszym interesie osoby tworzącej dokumentację techniczną jest dbanie o udane interakcje z twórcami produktu, testerami, ekspertami, jak i z przedstawicielami kadry zarządzającej. Potrzebny jest też konstruktywny przepływ informacji. W osiągnięciu tych celów szczególnie pomocnymi cechami okazują się być zarówno spójność i ciekawość, jak i empatia wobec współpracowników i odbiorców tekstów. Najważniejszą kwestią jest uświadamianie tego, że wszyscy zaangażowani wspólnie starają się osiągnąć jeden cel, jakim jest sukces projektu.

Powyższy akapit prezentuje interakcje, w jakie uwikłany jest specjalista ds. dokumentacji. Szczególnie trafne jest podkreślenie faktu, że dbanie o te relacje jest kluczem do pełni sukcesu w tej roli. Zgadzam się również z tym, że zdolność postawienia się w sytuacji innych uczestników procesu jest po prostu nieodzowna, o czym zbyt często się nie mówi. Równie ważnym aspektem jest umiejętność propagowania działań wspierających dokumentację dla osiągnięcia wspólnego celu przekładającego się na cały projekt. Jak już wspomniałem wcześniej, wpisanie dokumentacji w misję całego działu i firmy może przysparzać trudności, dlatego bywa, że wyegzekwowanie wsparcia dla technical writera przez resztę zespołu nie zawsze przychodzi łatwo. Stąd istotna jest „ewangelizacja” zarówno wśród bezpośrednich współpracowników, jak i managerów średniego i wyższego szczebla.


Since many deliverables of technical communication constitute a direct link between the product and its users, apart from technological aspects of the process, creation of such content requires the writer to also fully understand the psychology of the audience.


Wiele materiałów dostarczanych w ramach komunikacji technicznej stanowi ogniwo bezpośrednio łączące produkt i jego użytkowników. Tworzenie takich treści, oprócz znajomości technologicznych aspektów procesu, wymaga również pełnego zrozumienia psychologii odbiorców.

W pełni zgadzam się z tym, że skuteczna komunikacja wymaga znajomości oczekiwań i sposobu myślenia klientów. Tu znów empatia okazuje się niezbędną zdolnością. Podjęcie dodatkowego wysiłku, by nie tylko opisać dostępne funkcjonalności, ale również poznać sposoby wykorzystywania ich przez klientów, to trudna, ale bardzo owocna droga.


On project level, documentation development constitutes an additional layer for testing. Technical communication professionals usually act as early users of the product which implies sharing the responsibility with the quality assurance department in terms of reporting any encountered issues.


Na poziomie projektu, działania związane z tworzeniem dokumentacji stanowią wsparcie dla testowania produktu. Specjaliści od dokumentacji technicznej są często jednymi z pierwszych użytkowników i razem z działem zapewniania jakości mają obowiązek zgłaszać napotkane problemy.

Dokumentacja wpływa na jakość produktu – warto o tym pamiętać.

 

Sekcja 1.5: Etyka zawodowa

[…] apart from practical preparation, technical communication professionals need to understand and respect the ethical foundations implied by their profession.


[...] poza praktycznymi aspektami przygotowania materiału, specjaliści komunikacji technicznej muszą rozumieć i respektować kwestie etyczne wynikające z ich profesji.

Aspekt etyczny zawsze jest obecny, choć nieczęsto jest poruszany. Obowiązkiem twórcy dokumentacji jest rzetelne informowanie klienta poprzez dostarczanie jak najpełniejszego opisu produktu. Technical writer dokłada wszelkich starań, by pozyskać i przekazać esencję potrzebnej wiedzy, dbając o interes klienta.

Zależnie od tematyki, niektóre błędy w dokumentacji mogą wiązać się z ryzykiem i kosztami dla zleceniodawcy.

W skrajnych przypadkach, w branżach takich jak motoryzacyjna, lotnicza czy medyczna, osoba zajmująca się dokumentacją może dostrzec problem mogący potencjalnie mieć wpływ na bezpieczeństwo końcowego produktu i jego użytkowników. W takiej sytuacji konieczne jest zgłoszenie go odpowiednimi kanałami tak, by ryzyko zostało zażegnane. Bezpieczeństwo jest w interesie każdego, nawet jeśli dana rola nie wiąże się bezpośrednio z zapewnieniem jakości. Dobrze działający proces dokumentacji ma korzystny wpływ na przepływ informacji wewnątrz firmy i prowadzi do skonfrontowania różnych punktów widzenia na dany aspekt produktu, co pozytywnie wpływa na jakość.

Nie są to oczywiście jedyne kwestie etyczne, które trzeba mieć na uwadze. Zainteresowanych dodatkowymi przemyśleniami, zapraszam do zapoznania się z sylabusem ITCQF. Znajdziecie w nim jeszcze więcej pomocnych informacji.

Osoby stawiające pierwsze kroki znajdą wyczerpujący opis wszystkich głównych nurtów komunikacji technicznej – wiedza w pigułce. ITCQF zawiera uniwersalną strukturę, o którą można oprzeć swoje praktyki, niezależnie od branży w jakiej się pracuje. Nie trzeba wymyślać koła na nowo, a zaoszczędzoną energię można przeznaczyć na aspekty unikalne dla Twoich projektów ;).

Osoby zaawansowane ugruntują swoją wiedzę i zobaczą proces dokumentacyjny z szerszej perspektywy, ujęty w obiektywne standardy branży, co pomoże im opisać lub udoskonalić procedurę.

Kto wie, może i Ciebie sylabus ITCQF wciągnie jak dobra powieść, bo napisana została przez pasjonatów tematu, chcących promować znaczenie dokumentacji wśród praktyków i nie tylko.