技術作家:他們是什麼,你需要一個嗎?

已發表: 2022-03-11

技術作家指南

作家可以在專業寫作領域擔任多個不同的職位。 雖然行業外的企業傾向於濫用術語,但每種作家都有特定的角色和特定的職責。 如果你想讓他們做最好的工作,僱傭正確類型的作家是很重要的。

  • 作者,通常寫不太正式的長篇內容,如書籍。
  • 文案通常為廣告、社交媒體帖子、產品描述和其他媒體編寫簡短的副本。
  • 技術作家,通常編寫產品文檔和幫助中心材料。
  • 博主通常專注於網絡發布的中等長度內容。

而且,當然,你也有特定行業的作家,比如醫學作家或非營利部門的資助作家。 最重要的是,他們都可以是代筆人,也是。

正如今天帖子的標題所暗示的那樣,我將深入研究其中一個角色。 具體來說,讓我們談談技術作家。

目錄
什麼是技術作家?
具體來說,技術作家做什麼?
技術作家需要什麼技能?
任何人都可以成為技術作家嗎?
您需要技術作家嗎?

什麼是技術作家?

假設您購買了一種新產品。 你找到它並打開它,會發現一本 50 頁的手冊,裡面有零件圖、規格圖以及有關其工作原理的操作說明。 它是半複雜的,所以你需要參考手冊。

這就是技術作家所做的,也是他們獲得技術寫作職位的方式。

“技術作家撰寫公司文檔,例如說明手冊、中間到最終用戶手冊、參考指南、操作程序指南、白皮書和專業產品描述。” – 技術作家總部。

技術作家創建的內容可以用於不同的目的,包括:

  • 內部業務使用內容包括程序文檔、用戶指南、手冊、服務文檔或報告。
  • 外部業務使用內容包括使用指南、維修指南、知識庫文檔、客戶服務文檔和客戶提案文檔。

因此,您的技術作家可能會幫助起草員工手冊、編寫您的內部知識庫 wiki,或者構建客戶服務數據庫或常見問題解答。 他們可能會編寫產品使用手冊或記錄業務流程以實現內部一致性。 他們還可以為更高級別的執行團隊創建報告和建議,並促進 C 級和董事之間的溝通。

Mailchimp 示例技術內容

正如您所料,所有這些都屬於“技術文檔”的標題,因此屬於技術作家。 正如您所料,內容本身是技術性的。

技術作家可以是:

  • 自由承包商,按項目工作。
  • 長期承包商,致力於記錄有關業務的所有內容,直到趕上。
  • 兼職或全職員工,在整個運營過程中根據需要記錄所有內容。

技術作家很少是代筆作家。 代筆作家通常通過出售署名來換取金錢。 技術文檔很少有署名,因此無需聘請代筆而不是普通作家來製作它。 期望不存在。

具體來說,技術作家做什麼?

技術寫作的廣泛領域相當複雜。 一家公司的專業作家可能與另一家公司的作家有著完全不同的職責。

您會在技術作家的職位描述中找到的典型職責包括:

  • 研究業務部門、流程或產品的技術規範。
  • 按邏輯順序規劃技術文檔。
  • 了解對目標受眾來說什麼是必要的,什麼不是。
  • 創建、複製和完善文檔。
  • 根據需要創建圖表和其他插圖。
  • 維護相關詞彙表、常見問題解答或其他相關術語庫。
  • 為高級業務使用開發技術報告或正式提案。

許多作家將擁有技術寫作證書、發表的期刊文章或現有作品,以及在各自領域的多年經驗。 他們應該能夠證明他們在您的特定行業擁有技術寫作生涯。

您的汽車隨附的手冊教您如何更換輪胎或使用轉向信號燈,是一篇技術文章。 維修手冊也是如此,適用於機械師而非最終用戶。 汽車製造商網站上的客戶自助服務知識庫也充滿了技術內容。

所有的海恩斯手冊、谷歌的幫助中心,甚至像案例研究這樣的東西都是技術寫作的例子。

Google Search Console 幫助文章示例

技術作家需要是他們所在領域的不懈專家(但不一定是經過認證的)。 汽車製造商的技術作家需要從內到外了解汽車的設計。 醫學領域的技術作家需要對生物化學有足夠的了解才能正確記錄藥物。 業務的技術作家需要了解業務的運作方式,以適當地編寫流程文檔。

也就是說,技術作家經常讓主題專家審查他們的最終產品並批准它。 例如,醫學作家可能有真正的生物化學家審查並確保准確性。 創建產品手冊的技術作家可能會在發布之前讓律師查看它,以確保其中沒有任何內容能夠為公司帶來責任。

畢竟,技術文檔需要準確,並且需要為適當的受眾編寫。

再次使用汽車製造商示例,銷售規格文檔、用戶手冊和維修手冊必須包含類似的技術信息。 但是,最有價值的信息會有所不同,技術細節的級別會有所不同,並且文檔的範圍也會發生變化。

示例自動指南

向最終用戶提供海恩斯手冊是不恰當的。 那是因為想要買車、想要排除車輛故障的人以及專業修理車輛的人都有不同的需求。 大多數人對汽車知識的需求包括使用轉向燈和給輪胎充氣,而不是更換空氣管道或更換催化轉化器。

技術作家需要什麼技能?

技術作家需要一套特定的寫作技巧和溝通技巧才能有效。

1.首先,他們需要是高效的溝通者。 技術作家需要將準確的技術信息傳達給最終用戶以理解和解析它。 如果指南中充滿了他們難以理解的複雜信息,那麼它將令人困惑到無用的地步。 如果太簡單,用戶將得不到任何價值。

同時,技術作者可能需要向主題專家提出實際問題。 在他們的文檔中,他們可能會遇到他們沒有也找不到答案的問題。 他們需要向相關專家詢問他們需要了解哪些文檔。 而且,由於專家可能不知道何時停止,技術作者還需要知道如何從可能冗長的響應中提取特定值。

技術內容的示例 Slack 通信

2.相關地,技術作家需要牢牢掌握他們的語言。 他們需要準確地說出他們所說的內容,並寫到實用的閱讀水平,專門針對他們的聽眾。 技術錯誤、選詞不當、含義混亂; 對於技術文檔來說都是可怕的。

3.接下來,他們需要有一個注重細節的視角。 技術作家需要關注小細節,因為小細節需要準確。 他們不能掩蓋特定的細節,因為這些細節可能是必要的。

Z
Z
Z
您的博客是否為您帶來了生意? 如果沒有,讓我們解決這個問題。

我們創建可轉化的博客內容——不僅為我們自己,也為我們的客戶。

我們選擇博客主題,例如對沖基金選擇股票。 然後,我們創建的文章要好 10 倍以贏得頭把交椅。

內容營銷有兩個要素——內容和營銷。 我們在這兩方面都獲得了黑帶。

如果您經營一家基於互聯網的企業並希望擴大規模,請安排電話與我們的創始人交談:
免費策略調用

例如,在我關於某個 Web 服務或另一個的操作指南中,我可能會寫如下內容:

“登錄您的儀表板並在側邊欄中找到報告部分。”

這對我來說已經足夠了,因為我不是在寫技術文檔; 我正在寫一個非常簡單的操作指南。 同時,技術作家可能會寫道:

“在儀表板中,單擊左側邊欄中的報告標題,從頂部數第三個。”

它們更具體,因為技術文檔的一部分是特異性的。 當然,這是一個通用的例子。

4.技術作家也需要理解邏輯流程。 在記錄業務流程時,您的作者將需要批判性思維能力,並且需要適當地排序步驟。 例如,考慮一個食譜。 您按照完成的順序依次寫下烘烤一條麵包的分步說明。 但是,您也許可以重新組織一些; 例如,沒有理由在烘烤前對麵團進行一個小時的打樣時,將“烤箱預熱”放在開頭; 沒有人願意讓他們的烤箱在裡面空無一物地運行那麼久。

不同的汽車製造商有不同的模式。 文檔越長或越大,選擇就越多,建立約定就越重要。 自動手冊可能從可用性開始,然後轉向隱藏功能和小修。

豐田汽車指南示例

5.這與對技術作家的另一個要求有關,即單一來源。 單一來源意味著獲取大量信息並製作針對不同受眾的多條內容。 用戶手冊和海恩斯手冊的汽車示例就是一個很好的例子; 它們都包含來自同一來源(製造商)的同一輛車的信息,但其中一個更具技術性。

6.一些技術作家可能還需要基本的代碼或Web開發知識。 例如,創建客戶服務文檔的技術作家可能需要了解足夠多的 HTML、CSS、JavaScript 或 Wiki 語法才能從頭開始或在框架內創建基於 Web 的文檔。 技術作家很少寫純文本副本 - 通常他們需要另一種技能才能被視為技術作家。

技術內容代碼示例

例如,全棧開發的技術作家可能有兩種技能:技術寫作和編程。 如果不是程序員,作家沒有其他方法可以創建這種準確的程序員內容。

任何人都可以成為技術作家嗎?

老實說,沒有。

技術寫作是一種特殊的高風險寫作。 它具有異常嚴格的質量標準,因為糟糕的文檔可能會給公司帶來許多問題。 糟糕的文檔會大大降低用戶體驗和對產品的滿意度。 高效的技術寫作流程可以為企業大規模節省數百萬美元。

例如,假設一家軟件開發公司的指南太混亂或難以讓用戶理解。 在這種情況下,他們的流失率將高於平均水平,他們將​​失去大量客戶——這一切都是由於寫作不佳。

技術作家需要注重細節的個性和社交能力的特定組合才能與主題專家互動。 通常,技術作家還需要其主題的學位或技術證書才能適當地寫它。

例如,醫學作家可能會獲得護理學位或醫學科學或計算機科學的 4 年制學位。 作者甚至可以參加針對醫學內容的特定技術寫作課程。 他們不需要攻讀碩士或博士課程,但他們至少需要一些正規教育,例如學士學位。

班級和本科生的例子

許多技術內容作者選擇感興趣的行業並專注於它。

也就是說,技術作家並不總是需要這些學位才能進入某個領域。 通常,他們所需要的只是英語或寫作、新聞學、技術傳播或工程等技術領域的學位(儘管這種情況往往不太常見。)

我已經做了十多年的作家,但作為一個博主,我不會成為一名技術作家。 當然,我可以學習如何,但我必須抑制我的許多習慣(比如以第一人稱視角或隨意寫作)。

您需要技術作家嗎?

也許!

幾乎每個企業都需要某種程度的商業寫作和技術文檔。 我經營著一家小型企業,但我仍然製作諸如房屋風格指南、內容簡介或我的網站隱私政策之類的東西。

但是,我不會說我需要技術作家。 我可以在在線模板和內部文檔所需的較低標準之間編寫技術。

內容驅動的技術內容示例

假設您的業務在您有客戶服務需求的領域運營,而不僅僅是接聽電話和與客戶交談。 在這種情況下,您可能會受益於讓技術作家創建文檔。 如果您的大型部門具有生成報告或使用 ATS 的特定流程,技術作家可以記錄這些流程。

當然,如果您的企業生產技術產品,並且該產品比鋼筆或鞋子更複雜,那麼為您的用戶創建用戶手冊或在線幫助中心可能是個好主意。

即便如此,並非所有公司都為他們的手冊使用技術作家。 考慮宜家; 他們以在彙編指令中只使用象形圖而聞名,部分原因是他們希望單個文檔與整個世界相關,而不管語言如何。 技術作家可能已經製作了這些,但與其說是寫作,不如說是圖形設計。

我可以說一件事:技術寫作是一項特定的技能,是一項很難培養的技能。

根據美國勞工統計局的數據,技術作家的平均年收入約為 75,000 美元,高端、高技能的技術作家每年的收入超過 100,000 美元,這是有充分理由的。 在適當的情況下,它們的價值堪比黃金。

您是否正在考慮聘請技術作家? 您對我們有任何關於技術作家的問題,以及他們與文案或內容作家的區別嗎? 請在評論區告訴我! 我很樂意提供幫助並開始就這個主題進行對話。