Uwaga: Poniższy artykuł pomoże Ci w: Pisarze techniczni: kim oni są i czy ich potrzebujesz?
Pisarz może zająć kilka różnych stanowisk w świecie profesjonalnego pisania. Podczas gdy firmy spoza branży mają tendencję do nadużywania terminologii, każdy rodzaj pisarza pełni określoną rolę i ma określone obowiązki. Niezbędne jest zatrudnienie odpowiedniego typu pisarza, jeśli chcesz, aby wykonali najlepszą możliwą pracę.
- Autorzy, którzy zazwyczaj piszą mniej formalne, długie treści, takie jak książki.
- Copywriterzy zazwyczaj piszą krótkie teksty do reklam, postów w mediach społecznościowych, opisów produktów i innych mediów.
- Pisarze techniczni, którzy zwykle piszą dokumentację produktu i materiały centrum pomocy.
- Blogerzy zazwyczaj koncentrują się na treściach o średniej długości do publikacji w Internecie.
I, oczywiście, masz także pisarzy specyficznych dla branży, takich jak pisarze medyczni lub autorzy grantów dla sektora non-profit. Co więcej, wszyscy z nich mogą być także ghostwriterami.
Jak sugeruje tytuł dzisiejszego postu, zagłębię się w jedną z tych ról. W szczególności porozmawiajmy o pisarzach technicznych.
Co to jest pisarz techniczny?
Załóżmy, że kupiłeś nowy produkt. Znajdujesz go i otwierasz, i znajdujesz 50-stronicowy podręcznik pełen schematów części, specyfikacji i instrukcji, jak to działa. Jest to częściowo skomplikowane, więc musisz odnieść się do instrukcji.
To właśnie robi autor tekstów technicznych i w ten sposób zdobył tytuł zawodowy.
Treść stworzona przez autora tekstów technicznych może służyć różnym celom, w tym:
- Wewnętrzny użytek biznesowy zawartość obejmuje dokumentację procedur, podręczniki użytkownika, podręczniki, dokumenty serwisowe lub raporty.
- Zewnętrzny użytek biznesowy zawartość obejmuje przewodniki użytkowania, przewodniki napraw, dokumentację bazy wiedzy, dokumentację obsługi klienta i dokumentację propozycji klienta.
Twój pisarz techniczny może więc pomóc w opracowaniu podręcznika dla pracowników, napisaniu wiki wewnętrznej bazy wiedzy lub zbudowaniu bazy danych obsługi klienta lub często zadawanych pytań. Mogą napisać podręcznik użytkowania produktu lub udokumentować procesy biznesowe w celu zapewnienia wewnętrznej spójności. Mogą również tworzyć raporty i propozycje dla zespołów wykonawczych na wyższych szczeblach oraz ułatwiać komunikację między poziomami C i Dyrektorami.
Jak można się spodziewać, wszystko to mieści się w kategorii „dokumentacja techniczna”, stąd pisarze techniczni. Sama treść jest, jak można się spodziewać, techniczna.
Autorami technicznymi mogą być:
- Niezależni kontrahenci, pracujący według projektu.
- Długoterminowi kontrahenci, pracujący nad dokumentowaniem wszystkiego o firmie, dopóki nie zostanie to nadrobione.
- Pracownicy zatrudnieni w niepełnym lub pełnym wymiarze godzin, dokumentujący wszystko w miarę potrzeb w trakcie operacji.
Pisarze techniczni bardzo rzadko są ghostwriterami. Ghostwriter zwykle wymienia pisanie na pieniądze, sprzedając tytuł. Dokumentacja techniczna rzadko ma tytuł, więc nie ma potrzeby zatrudniania ghostwritera zamiast zwykłego pisarza, aby ją wyprodukował. Oczekiwania nie istnieją.
Co konkretnie robi pisarz techniczny?
Szeroka dziedzina pisania technicznego jest dość złożona. Wyspecjalizowany pisarz w jednej firmie może mieć zupełnie inny zestaw obowiązków niż pisarz w innej firmie.
Typowe obowiązki, które znajdziesz w opisie stanowiska pisarza technicznego, mogą obejmować:
- Badanie specyfikacji technicznych działu biznesowego, procesu lub produktu.
- Zaplanuj dokumentację techniczną w logicznej kolejności.
- Zrozum, co jest konieczne, a co nie dla grupy docelowej.
- Twórz, kopiuj i udoskonalaj dokumentację.
- W razie potrzeby twórz diagramy i inne ilustracje.
- Utrzymuj odpowiedni glosariusz, często zadawane pytania lub inną bibliotekę odpowiedniej terminologii.
- Opracuj raporty techniczne lub sformalizowane propozycje do użytku biznesowego na wysokim szczeblu.
Wielu pisarzy będzie miało certyfikat pisania technicznego, opublikowane artykuły w czasopismach lub istniejące prace oraz lata doświadczenia w swojej dziedzinie. Powinni być w stanie wykazać, że mają karierę w pisaniu technicznym w Twojej konkretnej branży.
Dołączona do samochodu instrukcja, która uczy, jak wymienić oponę lub używać kierunkowskazów, to pismo techniczne. Podobnie jest z instrukcją serwisową, która jest przeznaczona dla mechaników, a nie dla końcowego użytkownika. Baza wiedzy samoobsługi dla klientów na stronie internetowej producenta samochodów jest również wypełniona treściami technicznymi.
Wszystkie z tych Podręczniki Haynesa, Centrum pomocy Googlea nawet takie rzeczy Studium przypadku są przykładami pisma technicznego.
Pisarze techniczni muszą być niezłomni eksperci w swojej dziedzinie (ale niekoniecznie certyfikowany). Pisarz techniczny dla producenta samochodów musi zrozumieć konstrukcję samochodu wewnątrz i na zewnątrz. Pisarz techniczny w dziedzinie medycyny musi wiedzieć wystarczająco dużo o biochemii, aby właściwie dokumentować leki. Pisarz techniczny dla firmy musi zrozumieć, jak funkcjonuje firma, aby odpowiednio napisać dokumentację procesu.
To powiedziawszy, pisarze techniczni często zlecają ekspertom merytorycznym przegląd ich końcowego produktu i zatwierdzanie go. Na przykład pisarz medyczny może mieć rzeczywistą recenzję biochemiczną i zapewnić dokładność. Pisarz techniczny tworzący instrukcję produktu może poprosić prawnika o przejrzenie jej przed publikacją, aby zagwarantować, że nie ma w niej nic, co mogłoby spowodować odpowiedzialność firmy.
W końcu dokumentacja techniczna musi być dokładna i musi być napisana dla odpowiednich odbiorców.
Aby ponownie użyć przykładu producenta samochodów, specyfikacja sprzedaży, instrukcja obsługi i instrukcja naprawy muszą zawierać podobne informacje techniczne. Różnią się jednak informacje o największej wartości, różny jest poziom szczegółowości technicznej i zmienia się zakres dokumentacji.
Udostępnianie instrukcji Haynes użytkownikowi końcowemu jest niewłaściwe. Dzieje się tak, ponieważ ludzie, którzy chcą kupić samochód, chcą rozwiązać problem ze swoim pojazdem, oraz ludzie, którzy profesjonalnie naprawiają pojazdy, mają różne potrzeby. Potrzeba większości ludzi w zakresie wiedzy samochodowej obejmuje używanie kierunkowskazów i pompowanie opon, a nie wymianę kanałów powietrznych lub wymianę katalizatora.
Jakich umiejętności potrzebuje pisarz techniczny?
Pisarze techniczni potrzebują określonego zestawu umiejętności pisania i umiejętności komunikacyjnych, aby byli skuteczni.
1. Po pierwsze, muszą być wysoce skuteczne komunikatory. Pisarz techniczny musi przekazać dokładne i techniczne informacje użytkownikowi końcowemu, aby je zrozumieć i przeanalizować. Jeśli przewodnik jest wypełniony złożonymi informacjami, które są dla nich zbyt trudne do zrozumienia, będzie to dezorientujące do punktu bezużyteczności. Jeśli jest to zbyt proste, użytkownik nie uzyska żadnej wartości.
W tym samym czasie autor techniczny może zadawać praktyczne pytania ekspertom w danej dziedzinie. W swojej dokumentacji mogą napotkać pytania, których nie mają i na które nie mogą znaleźć odpowiedzi. Muszą zapytać odpowiedniego eksperta, co muszą wiedzieć o dokumentacji. A ponieważ ekspert może nie wiedzieć, kiedy przestać, autor tekstów technicznych musi również wiedzieć, jak wydobyć konkretną wartość z potencjalnie długiej odpowiedzi.
2. W związku z tym pisarze techniczni potrzebują mocne zrozumienie ich języka. Muszą być precyzyjni w tym, co mówią i pisać na poziomie praktycznego czytania, skierowanym specjalnie do ich odbiorców. Błędy techniczne, zły dobór słów, pomieszane znaczenia; są straszne dla dokumentacji technicznej.
3. Następnie muszą mieć perspektywę zorientowaną na szczegóły. Pisarz techniczny potrzebuje oka na drobne szczegóły, ponieważ drobne szczegóły muszą być dokładne. Nie mogą przemilczeć konkretnych szczegółów, ponieważ te szczegóły mogą być konieczne.
Na przykład w jednym z moich poradników dotyczących jakiejś usługi internetowej mógłbym napisać coś w stylu:
To mi wystarczy, ponieważ nie piszę dokumentacji technicznej; Piszę całkiem prosty poradnik. Tymczasem pisarz techniczny może napisać:
Są bardziej szczegółowe, ponieważ częścią dokumentacji technicznej jest specyfika. Oczywiście to ogólny przykład.
4. Potrzebują również pisarze techniczni zrozumienie przepływu logicznego. Podczas dokumentowania procesu biznesowego pisarz będzie wymagał umiejętności krytycznego myślenia, a kroki muszą być odpowiednio uporządkowane. Rozważmy na przykład przepis. Piszesz instrukcje krok po kroku dotyczące pieczenia bochenka chleba, jedna po drugiej, w kolejności ich wykonania. Jednak możesz być w stanie zreorganizować niektóre; na przykład nie ma powodu, aby ustawiać „rozgrzej piekarnik” na początku, gdy jest godzina wyrastania ciasta przed pieczeniem; nikt nie będzie chciał pozwolić, aby jego piekarnik działał tak długo bez niczego w środku.
Różni producenci samochodów mają różne wzory. Im dłuższy lub większy fragment dokumentacji, tym więcej opcji i tym bardziej krytyczne staje się ustalenie konwencji. Instrukcje obsługi samochodów mogą zaczynać się od użyteczności, a następnie przejść do ukrytych funkcji i drobnych napraw.
5. Wiąże się to z innym wymogiem dla autorów technicznych, tj pojedyncze zaopatrzenie. Pojedyncze źródło oznacza pobranie zbioru informacji i wyprodukowanie wielu treści skierowanych do różnych odbiorców. Dobrym przykładem jest instrukcja obsługi samochodu i instrukcja Haynesa; oba zawierają informacje o tym samym samochodzie z tego samego źródła (producenta), ale jeden jest o wiele bardziej techniczny.
6. Niektórzy pisarze techniczni mogą również potrzebować podstawowa wiedza o kodzie lub tworzeniu stron internetowych. Na przykład pisarz techniczny tworzący dokumentację obsługi klienta może potrzebować wystarczającej wiedzy na temat składni HTML, CSS, JavaScript lub Wiki, aby rozpocząć tworzenie dokumentacji internetowej od podstaw lub w ramach. Pisarze techniczni rzadko piszą czysty tekst — generalnie wymagana jest inna umiejętność, aby mogli zostać uznani za pisarzy technicznych.
Na przykład pisarz techniczny zajmujący się pełnym rozwojem ma prawdopodobnie dwie umiejętności: pisanie techniczne i programowanie. Nie ma innego sposobu, aby pisarz mógł stworzyć tego rodzaju dokładne treści dla programistów, nie będąc programistą.
Czy każdy może zostać pisarzem technicznym?
Szczerze nie.
Pisanie techniczne to szczególny rodzaj pisania o wysokich stawkach. Ma wyjątkowo wyśrubowane standardy jakości, ponieważ zła dokumentacja może przysporzyć firmie wiele problemów. Słaba dokumentacja może radykalnie obniżyć komfort użytkowania i zadowolenie z produktu. Wydajny proces pisania technicznego może zaoszczędzić firmom miliony dolarów na dużą skalę.
Załóżmy na przykład, że firma programistyczna ma przewodnik, który jest zbyt zagmatwany lub trudny do zrozumienia dla użytkowników. W takim przypadku ich wskaźnik rezygnacji będzie wyższy niż średnia i stracą dużą garstkę klientów – wszystko z powodu złego pisania.
Pisarze techniczni potrzebują specyficznej mieszanki osobowości zorientowanej na szczegóły i towarzyskości, aby współpracować z ekspertami merytorycznymi. Często pisarz techniczny wymaga również dyplomu lub certyfikatu technicznego w swojej dziedzinie, aby odpowiednio o tym pisać.
Na przykład pisarz medyczny może uzyskać stopień pielęgniarski lub 4-letni dyplom z nauk medycznych lub informatyki. Pisarz może nawet podjąć konkretne techniczne kursy pisania treści medycznych. Nie muszą realizować programu studiów magisterskich lub doktoranckich, ale potrzebują przynajmniej sformalizowanej edukacji, takiej jak tytuł licencjata.
Wielu autorów treści technicznych wybiera interesującą branżę i specjalizuje się w niej.
To powiedziawszy, pisarze techniczni nie zawsze potrzebują tych stopni, aby wejść w dziedzinę. Często wszystko, czego potrzebują, to dyplom z języka angielskiego lub pisania, dziennikarstwa, komunikacji technicznej lub dziedziny technicznej, takiej jak inżynieria (choć jest to mniej powszechne).
Piszę od ponad dekady, ale jako bloger nie odniosę sukcesu jako pisarz techniczny. Pewnie, mógłbym się tego nauczyć, ale musiałbym porzucić wiele moich nawyków (takich jak pisanie z perspektywy pierwszej osoby lub niedbale).
Czy potrzebujesz pisarza technicznego?
Może!
Prawie każda firma ma potrzeby pisania dokumentacji biznesowej i technicznej na pewnym poziomie. Prowadzę małą firmę, ale nadal tworzę takie rzeczy, jak przewodnik po stylu domu, zestawienia treści lub polityka prywatności mojej witryny.
Jednak nie powiedziałbym, że potrzebuję pisarza technicznego. Potrafię pisać techniczne pomiędzy szablonami online a niższymi standardami niezbędnymi dla mojej dokumentacji wewnętrznej.
Załóżmy, że Twoja firma działa w obszarze, w którym potrzebujesz obsługi klienta wykraczającej poza odbieranie telefonu i rozmowę z klientami. W takim przypadku możesz skorzystać z pomocy autora dokumentacji technicznej. Jeśli masz duże działy z określonymi procesami do generowania raportów lub pracy z ATS, autor techniczny może udokumentować te procesy.
I oczywiście, jeśli Twoja firma produkuje produkt techniczny, a produkt ten jest czymś bardziej skomplikowanym niż długopis czy but, istnieje duże prawdopodobieństwo, że stworzenie instrukcji obsługi lub centrum pomocy online dla użytkowników to dobry pomysł.
Nawet wtedy nie wszystkie firmy używają pisarzy technicznych do swoich podręczników. Rozważ Ikeę; słyną z używania wyłącznie piktogramów w swoich instrukcjach montażu, częściowo dlatego, że chcą, aby pojedyncza dokumentacja dotyczyła całego świata, niezależnie od języka. Pisarz techniczny mógł je wyprodukować, ale to nie tyle pisanie, co projektowanie graficzne.
Mogę powiedzieć jedno: pisanie techniczne jest specyficzną umiejętnością i trudno ją kultywować.
Pisarze techniczni zarabiają średnio około 75 000 USD rocznie, według amerykańskiego Biura Statystyki Pracy, z wysokiej klasy, wysoko wykwalifikowanymi pisarzami technicznymi, zarabiającymi 100 000 $ rocznie i nie bez powodu. W odpowiednich okolicznościach są na wagę złota.
