Pisarze techniczni: czym są i czy ich potrzebujesz?

Pisarz może zajmować kilka różnych stanowisk w profesjonalnym świecie pisarskim. 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 wykonał najlepszą możliwą pracę.

• Autorzy, którzy zazwyczaj piszą mniej formalne, obszerne treści, takie jak książki.
• Copywriterzy zazwyczaj piszą krótkie teksty 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 do ​​centrum pomocy.
• Blogerzy zazwyczaj koncentrują się na średniej długości treści do publikacji w Internecie.

I oczywiście masz również pisarzy branżowych, takich jak pisarze medyczni lub pisarze grantów dla sektora non-profit. Co więcej, wszyscy z nich mogą też być ghostwriterami.

Jak sugeruje tytuł dzisiejszego postu, zagłębię się w jedną z tych ról. W szczególności porozmawiajmy o pisarzach technicznych.

Kim jest pisarz techniczny?

Załóżmy, że kupiłeś nowy produkt. Znajdujesz go i otwierasz, i znajdujesz 50-stronicowy podręcznik pełen diagramów części, specyfikacji i instrukcji, jak to działa. Jest częściowo skomplikowany, więc musisz odwołać się do instrukcji.

To właśnie robi pisarz techniczny i w ten sposób zdobyli tytuł zawodowy pisarza technicznego .

„Pisarz techniczny pisze dokumenty firmowe, takie jak instrukcje obsługi, podręczniki od średniozaawansowanych do użytkowników końcowych, przewodniki referencyjne, przewodniki po procedurach operacyjnych, białe księgi i specjalistyczne opisy produktów”. – Kwatera główna pisarza technicznego.

Treść stworzona przez pisarza technicznego może być stworzona do różnych celów, w tym:

• Treść wewnętrznego użytku biznesowego obejmuje dokumentację procedur, podręczniki użytkownika, podręczniki, dokumenty serwisowe lub raporty.
• Zawartość Zewnętrznego użytku biznesowego obejmuje przewodniki użytkowania, przewodniki naprawy, dokumentację bazy wiedzy, dokumentację obsługi klienta i dokumentację propozycji klienta.

Tak więc Twój autor techniczny może pomóc w przygotowaniu 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 C-levels a dyrektorami.

Jak można się spodziewać, wszystko to należy do kategorii „dokumentacja techniczna”, a więc pisarzy technicznych. Sama treść jest, jak można się spodziewać, techniczna.

Pisarze techniczni mogą być:

• Wykonawcy niezależni, pracujący nad projektem.
• Długoterminowi kontrahenci, pracujący nad dokumentowaniem wszystkiego, co dotyczy firmy, dopóki nie zostanie nadrobiony.
• 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 byline. Dokumentacja techniczna rzadko ma byline, więc nie ma potrzeby zatrudniania ghostwritera zamiast zwykłego pisarza do jej produkcji. Nie ma oczekiwań.

Co konkretnie robi pisarz techniczny?

Szeroka dziedzina pisma technicznego jest dość złożona. Wyspecjalizowany pisarz w jednej firmie może mieć zupełnie inny zakres 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.
• Rozplanuj dokumentację techniczną w logicznej kolejności.
• Zrozum, co jest konieczne, a co nie dla grupy docelowej.
• Twórz, edytuj i ulepszaj dokumentację.
• W razie potrzeby twórz diagramy i inne ilustracje.
• Utrzymuj odpowiedni glosariusz, FAQ lub inną bibliotekę stosownej terminologii.
• Opracuj raporty techniczne lub sformalizowane propozycje do użytku biznesowego na wysokim poziomie.

Wielu pisarzy będzie posiadało certyfikat pisania technicznego, opublikowane artykuły w czasopismach lub istniejące prace oraz wieloletnie doświadczenie w swojej dziedzinie. Powinni być w stanie wykazać, że mają karierę techniczną w Twojej konkretnej branży.

Instrukcja dołączona do samochodu, która uczy, jak wymienić oponę lub jak korzystać z kierunkowskazów, to kawałek pisarstwa technicznego. Podobnie jak instrukcja obsługi, przeznaczona dla mechaników, a nie dla użytkownika końcowego. Baza wiedzy na temat samoobsługi klienta na stronie internetowej producenta jest również wypełniona treściami technicznymi.

Wszystkie podręczniki Haynes, Centrum pomocy Google, a nawet takie rzeczy jak studia przypadków są przykładami pisania technicznego.

Pisarze techniczni muszą być niestrudzonymi ekspertami w swojej dziedzinie (ale niekoniecznie certyfikowanymi). Pisarz techniczny dla producenta samochodów musi zrozumieć konstrukcję samochodu od środka i na zewnątrz. Pisarz techniczny w dziedzinie medycyny musi wiedzieć wystarczająco dużo o biochemii, aby właściwie udokumentować leki. Pisarz techniczny dla biznesu musi zrozumieć, jak działa biznes, aby odpowiednio napisać dokumentację procesu.

To powiedziawszy, pisarze techniczni często zlecają ekspertom merytorycznym sprawdzenie ich końcowego produktu i zatwierdzenie go. Na przykład pisarz medyczny może mieć rzeczywistą recenzję biochemiczną i zapewnić dokładność. Pisarz techniczny tworzący podręcznik produktu może poprosić prawnika o przejrzenie go przed opublikowaniem, aby upewnić się, że nie ma w nim 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 skorzystać z przykładu producenta samochodu, dokument specyfikacji sprzedaży, instrukcja obsługi i instrukcja naprawy muszą zawierać podobne informacje techniczne. Zmieniają się jednak informacje o największej wartości, poziom szczegółowości technicznej i zakres dokumentacji.

Udostępnianie podręcznika Haynes użytkownikowi końcowemu jest niewłaściwe. Dzieje się tak, ponieważ ludzie, którzy chcą kupić samochód, chcą rozwiązać problem z pojazdem i ludzie, którzy profesjonalnie naprawiają pojazdy, mają różne potrzeby. Zapotrzebowanie większości ludzi na wiedzę o samochodach 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 komunikacji, aby być skutecznym.

1. Po pierwsze, muszą być bardzo skutecznymi komunikatorami. Pisarz techniczny musi przekazać użytkownikowi końcowemu dokładne i techniczne informacje, 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 zagmatwane do punktu bezużytecznego. Jeśli jest to zbyt proste, użytkownik nie otrzyma żadnej wartości.

Jednocześnie pisarz techniczny może być zmuszony do zadawania praktycznych pytań ekspertom w danej dziedzinie. W swojej dokumentacji mogą napotkać pytania, których nie mają i nie mogą znaleźć odpowiedzi. Muszą zapytać odpowiedniego eksperta, co muszą wiedzieć o dokumentacji. A ponieważ ekspert może nie wiedzieć, kiedy przestać, pisarz techniczny musi również wiedzieć, jak wyodrębnić konkretną wartość z potencjalnie długiej odpowiedzi.

2. W związku z tym pisarze techniczni potrzebują mocnego zrozumienia ich języka. Muszą być precyzyjni w tym, co mówią i pisać na praktycznym poziomie czytania, skierowanym specjalnie do ich odbiorców. Błędy techniczne, kiepski dobór słów, pogmatwane znaczenia; są okropne dla dokumentacji technicznej.

3. Następnie muszą mieć perspektywę zorientowaną na szczegóły. Pisarz techniczny musi zwracać uwagę na drobne szczegóły, ponieważ drobne szczegóły muszą być dokładne. Nie mogą zatuszować konkretnych szczegółów, ponieważ te szczegóły mogą być konieczne.

Na przykład w jednym z moich poradników dotyczących jakiegoś serwisu internetowego mógłbym napisać coś takiego:

„Zaloguj się do pulpitu nawigacyjnego i znajdź sekcję Raporty na pasku bocznym”.

To mi wystarczy, ponieważ nie piszę dokumentacji technicznej; Piszę całkiem prosty poradnik. Tymczasem pisarz techniczny może napisać:

„W panelu kliknij nagłówek Raporty na lewym pasku bocznym, trzeci od góry”.

Są bardziej szczegółowe, ponieważ częścią dokumentacji technicznej jest specyfika. Oczywiście to ogólny przykład.

4. Pisarze techniczni również potrzebują zrozumienia przepływu logicznego. Dokumentując proces biznesowy, twój 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, w jakiej zostały upieczone. Jednak możesz być w stanie zreorganizować niektóre; na przykład nie ma powodu, aby na początku wstawiać „rozgrzać piekarnik”, gdy przed pieczeniem jest godzina wyrastania ciasta; nikt nie będzie chciał, aby ich piekarnik tak długo działał 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 ważniejsze staje się ustalenie konwencji. Instrukcje obsługi samochodów mogą zaczynać się od użyteczności, a następnie przechodzić do ukrytych funkcji i drobnych napraw.

5. Wiąże się to z innym wymogiem dla pisarzy technicznych, którym jest pojedyncze zaopatrzenie. Pojedyncze pozyskiwanie oznacza zebranie zbioru informacji i wyprodukowanie wielu treści skierowanych do różnych odbiorców. Dobrym przykładem jest samochodowy przykład instrukcji obsługi i instrukcji Haynes; oba zawierają informacje o tym samym samochodzie z tego samego źródła (producenta), ale jeden jest znacznie bardziej techniczny.

6. Niektórzy autorzy techniczni mogą również potrzebować podstawowej wiedzy o kodzie lub tworzeniu stron internetowych. Na przykład pisarz techniczny tworzący dokumentację obsługi klienta może potrzebować wystarczającej znajomości HTML, CSS, JavaScript lub składni Wiki, aby rozpocząć dokumentację internetową od zera lub w ramach frameworka. Pisarze techniczni rzadko piszą czystą kopię tekstową – na ogół wymagana jest inna umiejętność, aby można było ich uznać za pisarzy technicznych.

Na przykład pisarz techniczny zajmujący się tworzeniem pełnego stosu prawdopodobnie ma dwie umiejętności: pisanie techniczne i programowanie. Nie ma innego sposobu na stworzenie przez pisarza tego rodzaju dokładnej treści programistycznej bez bycia programistą.

Czy każdy może być pisarzem technicznym?

Szczerze nie.

Załóżmy na przykład, że firma tworząca oprogramowanie ma przewodnik, który jest zbyt mylący lub trudny do zrozumienia dla użytkowników. W takim przypadku ich wskaźnik rezygnacji będzie wyższy niż przeciętny i stracą dużą garstkę klientów – wszystko z powodu słabego pisania.

Pisarze techniczni potrzebują specyficznej mieszanki osobowości zorientowanej na szczegóły i towarzyskości, aby nawiązać kontakt z ekspertami w danej dziedzinie. Często pisarz techniczny wymaga również stopnia naukowego 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 stopień naukowy w dziedzinie nauk medycznych lub informatyki. Pisarz może nawet wziąć udział w specjalnych kursach technicznych dotyczących pisania treści medycznych. Nie muszą realizować programu magisterskiego lub doktoranckiego, ale potrzebują przynajmniej pewnej sformalizowanej edukacji, takiej jak licencjat.

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ść na pole. Często wszystko, czego potrzebują, to dyplom z języka angielskiego lub pisania, dziennikarstwa, komunikacji technicznej lub dziedziny technicznej, takiej jak inżynieria (chociaż jest to mniej powszechne).

Jestem pisarzem od ponad dekady, ale jako bloger nie rozwijałbym się jako pisarz techniczny. Jasne, mógłbym się tego nauczyć, ale musiałbym stłumić wiele moich nawyków (takich jak pisanie z perspektywy pierwszej osoby lub od niechcenia).

Potrzebujesz pisarza technicznego?

Może!

Prawie każda firma potrzebuje pewnego poziomu pisania biznesowego i dokumentacji technicznej. Prowadzę niewielką firmę, ale nadal tworzę takie rzeczy, jak House Style Guide, briefy dotyczące treści lub polityka prywatności mojej witryny.

Jednak nie powiedziałbym, że potrzebuję pisarza technicznego. Potrafię pisać techniczne między szablonami online a niższymi standardami niezbędnymi dla mojej wewnętrznej dokumentacji.

Załóżmy, że Twoja firma działa w dziedzinie, w której masz potrzeby w zakresie obsługi klienta, wykraczające poza samo odbieranie telefonów i rozmowy z klientami. W takim przypadku możesz skorzystać z pomocy pisarza technicznego, który utworzy dokumentację. Jeśli masz duże działy z określonymi procesami 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 ten produkt jest czymś bardziej skomplikowanym niż długopis lub but, istnieje szansa, że ​​stworzenie instrukcji obsługi lub centrum pomocy online dla użytkowników jest dobrym pomysłem.

Nawet wtedy nie wszystkie firmy używają pisarza technicznego do swoich podręczników. Rozważmy Ikeę; słyną z tego, że w instrukcjach montażu używają tylko piktogramów, częściowo dlatego, że chcą, aby jeden fragment dokumentacji odnosił się do całego świata, niezależnie od języka. Być może stworzył je pisarz techniczny, ale nie tyle pisze, ile zajmuje się projektowaniem graficznym.

Według amerykańskiego Biura Statystyki Pracy, pisarze techniczni zarabiają średnio około 75 000 USD rocznie, a wysoko wykwalifikowani pisarze techniczni zarabiają na poziomie 100 000 USD rocznie, i nie bez powodu. W odpowiednich okolicznościach są na wagę złota.

Rozważasz zatrudnienie pisarza technicznego? Czy masz do nas jakieś pytania dotyczące pisarzy technicznych i tego, czym różnią się od copywriterów lub autorów treści? Daj mi znać w komentarzach! Chętnie pomogę i rozpocznę rozmowę na ten temat.