Pismo techniczne przekazuje czytelnikom informacje techniczne o umiejętności lub produkcie. Jest powszechnie stosowany w dziedzinach technicznych i zawodowych. Jako autor tekstów technicznych często piszesz dokumenty, takie jak podręczniki użytkownika, dokumentacja interfejsu programowania aplikacji (API) oraz instrukcje napraw i produktów.
Podobnie jak inne nisze pisarskie, pisanie techniczne ma wytyczne dla nisz. Postępowanie zgodnie z tymi wskazówkami pomoże Ci pisać dobrze ustrukturyzowane dokumenty i zoptymalizować sposób, w jaki czytelnicy rozumieją Twoją pracę. Oto kilka zasad, których należy przestrzegać, aby zostać dobrym pisarzem technicznym.
1. Zdefiniuj swoją publiczność
Analiza odbiorców jest nieodzownym elementem dobrego dokumentu technicznego. Znajomość odbiorców pomaga określić rodzaj informacji, o których należy pisać, sposób ich ustrukturyzowania oraz techniczny język. Istnieją cztery główne grupy odbiorców tekstów technicznych: dyrektorzy, eksperci, technicy i osoby niebędące specjalistami.
Kierownictwo to osoby, które finansują produkt i podejmują decyzje polityczne, administracyjne i ekonomiczne, które nim rządzą. Technicy to ludzie, którzy budują, obsługują i naprawiają te produkty. Eksperci projektują, testują i wiedzą wszystko o produkcie, podczas gdy niespecjalisty są końcowymi użytkownikami produktów. Musisz wziąć pod uwagę odbiorców, aby określić najlepszy ton i styl pisania.
2. Zidentyfikuj potrzeby swoich odbiorców
Oprócz poznania i zdefiniowania odbiorców, kluczowe jest zrozumienie ich celów, zainteresowań i potrzeb. Ukończenie analizy odbiorców jest kluczem do przygotowania dokumentu, ponieważ jest mniej prawdopodobne, że będziesz pisać bez czkawki i dobrze znasz potrzeby swoich odbiorców.
Aby przeprowadzić wszechstronną analizę odbiorców, musisz wziąć pod uwagę ich pochodzenie i obecną wiedzę produkt, doświadczenie, potrzeby, zainteresowania, cechy demograficzne, preferencje kulturowe i komunikacyjne oraz cele. Te informacje pomogą Ci w najbardziej efektywnym i efektywnym przedstawieniu swoich pomysłów.
3. Poznaj granice wiedzy swoich odbiorców
Jako technikę analizy odbiorców możesz wykorzystać ankiety i kwestionariusze, aby poznać granice wiedzy odbiorców. Możesz także pozyskać popularne opinie i stereotypy, osobiste doświadczenia, burze mózgów i opinie odbiorców z działu marketingu.
Jeśli odpowiednio wykorzystasz powyższe narzędzia, będziesz wiedział, w jakim stopniu Twoi odbiorcy docelowi rozumieją informacje, które zamierzasz przekazać. Te informacje w znacznym stopniu określą strukturę, ograniczenia i zakres dokumentu, dając poczucie kierunku.
4. Zachowaj prostotę języka
Pisanie techniczne ma przedstawiać zbyt skomplikowany temat. Czyni to za pomocą prostego przewodnika po stylu pisania. Powinieneś upewnić się, że przeciętny czytelnik może łatwo zrozumieć twoje pismo.
Musisz jednak pamiętać, że zrozumienie odbiorców jest również kluczem do wybranego stylu językowego. Na przykład żargon zawodowy w dokumencie nt interfejsy programowania aplikacji (API) może być odpowiedni dla techników, ale nie dla użytkowników końcowych. W związku z tym musisz używać łatwego do zrozumienia języka, aby pomóc odbiorcom w zrozumieniu. Ty też możesz chcieć się uczyć jak korzystać z narzędzia takiego jak Microsoft Editor aby sprawdzić swoją pracę i upewnić się, że pisanie jest na miejscu.
5. Użyj konturów
Konspekty dają czytelnikom wyobrażenie o tym, czego mogą się spodziewać w dokumencie. Dokument bez zarysu przytłacza czytelnika, zmuszając go do przeczytania całego tekstu, gdy interesuje go tylko zdobycie konkretnej wiedzy.
Jako pisarzowi technicznemu nakreślenie dokumentu daje również poczucie kierunku podczas pisania. Utrzymuje Cię na właściwej drodze i gwarantuje, że nie przegapisz ani nie docenisz istotnych punktów. Dodatkowo poprawia strukturę twojego dokumentu i służy jako informacja zwrotna na temat tego, co zamierzasz omówić.
6. Użyj grafiki tam, gdzie to konieczne
Uwagę większości czytelników w naturalny sposób przyciąga grafika, a nie tekst. W dokumentach technicznych odpowiednia grafika może poprawić zrozumienie tekstu przez czytelników, przedstawiając informacje w sposób jasny i dobitny.
Jednak jako autor tekstów technicznych powinieneś uważać, aby nie używać grafiki do ozdabiania dokumentów. Tabele, wykresy, wykresy, fotografie i ilustracje to powszechnie używane elementy graficzne, które mogą ulepszyć ogólną strukturę dokumentu i zwiększyć atrakcyjność dla czytelników. To powiedziawszy, jeśli jesteś nowy w Dokumentach Google, oto jak tworzyć i edytować tabele w Dokumentach Google.
7. Zaangażuj swoich czytelników
Chociaż możesz próbować przekazać czytelnikom informacje techniczne, ważne jest, aby ich również zaangażować. Każdy dokument techniczny jest skoncentrowany na czytelniku i powinien być napisany zgodnie z gustem czytelnika, a nie autora. Intelektualna ciekawość czytelnika musi zostać zaspokojona, aby dokument był użyteczny.
Możesz aktywnie zaangażować czytelnika, pisząc, aby wyrazić, a nie zaimponować, i przejść od razu do sedna. Unikaj skrótów i żargonu, używaj dużej ilości spacji, aby poprawić prezentację wizualną, i używaj nagłówków, aby poprowadzić czytelnika.
8. Nie odwołuj się do informacji wrażliwych na czas
Zawsze preferowane jest unikanie odniesień do informacji wrażliwych na czas, zwłaszcza tych dotyczących porównywalnego okresu. Bezpieczniej i mądrzej jest korzystać z analizy, która przetrwała próbę czasu, dzięki czemu jest zawsze aktualna i zawsze odpowiednia dla tych, którzy będą czytać Twój dokument w przyszłości.
Należy również pamiętać, że dołączenie konkretnych lat, np. „2019”, aby podkreślić swój punkt widzenia, może z czasem zmniejszyć użyteczność dokumentu, z wyjątkiem określonych przypadków. Możesz temu zapobiec, stosując szersze ramy czasowe, takie jak „W ciągu ostatnich siedmiu lat”, nadając w ten sposób swojej pracy poziom wiarygodności.
9. Użyj odpowiednich przykładów
Pisząc dokument techniczny, użyj żywych wystąpień, aby podkreślić swoje punkty. Ponieważ twoi odbiorcy czytają twoje teksty, aby nabyć umiejętności, rozwiązać problem lub nauczyć się pewnych wskazówek, musisz podać im praktyczne i możliwe do odniesienia przykłady.
Te przykłady zwiększają czytelność Twojej pracy i przekazują czytelnikowi złożone informacje, zapewniając kontekst produktom i procesom. W ten sposób jest bardziej prawdopodobne, że będą używać produktów celowo i bezpiecznie.
10. Uzyskaj recenzję strony trzeciej przed opublikowaniem
Dokument techniczny powinien zawsze przejść przez proces współpracy, w który zaangażowany jest autor i recenzent. Recenzja strony trzeciej pomaga wygenerować skoncentrowany na odbiorcach, wolny od błędów i wywierający wrażenie dokument.
Jako oryginalny autor dokumentu mogłeś napisać wiele wersji roboczych przed utworzeniem ostatecznej wersji dokumentu. Niemniej jednak, bez względu na to, jak dobry wydaje się twój dokument, nie polegaj wyłącznie na swoim sprytu.
Zostań profesjonalnym pisarzem technicznym już dziś
Zrozumienie podstawowych zasad rządzących pisaniem technicznym sprawi, że staniesz się bardziej biegły i bardzo poszukiwany. Wiele organizacji wie, jak ważne jest, aby ich produkty lub usługi były dobrze sprzedawane użytkownikom końcowym, a pomaganie im w osiągnięciu tego celu jest Twoim celem jako pisarza technicznego.