跳至內容

技術寫作人員

維基百科，自由的百科全書

技術寫作員（Technical Writer）是專業的信息傳播者。他們通過最便於傳遞和理解信息的媒介，在兩方或多方間傳遞信息或知識。這些信息的類型包括在線幫助、手冊、白皮書、設計規格書、項目計劃、軟件測試計劃等。隨着在線學習的發展，越來越多的技術寫作人員投入到創建在線培訓資料的工作中。

以下是 Society for Technical Communication (STC) 對技術寫作的解釋：[1]

技術寫作有時被定義為「將複雜的東西簡單化」。在這個簡短且看似簡單的定義中，所包含的是各種各樣的技能和特性，在某種程度上幾乎涉及到人類活動的所有領域。作為技術傳播領域中的一個重要分支，技術寫作涉及將複雜的信息傳達給那些需要它來完成某個任務或目標的人。

換言之，技術寫作人員將先進的技術概念以儘可能明確、準確、全面的方式傳達給目標讀者，並確保這些信息易於用戶獲取。

Kurt Vonnegut 將技術寫作人員描述為:[2]

...trained to reveal almost nothing about themselves in their writing. This makes them freaks in the world of writers, since almost all of the other ink-stained wretches in that world reveal a lot about themselves to the reader.

工程師、科學家、以及其他專業人員也可能參與技術寫作（策劃編輯、校對等），但通常會僱傭專業的技術寫作人員來開發和編輯資料、設計版面、並建議最佳的信息發布方式。

相關職位

  • Technical Communicator[3]
  • Technical Author
  • Tech Writer
  • Technical Content Developer
  • Content Developer
  • Content Designer
  • Information Developer
  • Technical Information Developer
  • Information Architect
  • Information Engineer
  • Information Designer
  • Documentation Specialist
  • Document Management Specialist
  • Documentation Manager
  • Text Engineer

職業的發展歷史

根據 Society for Technical Communication (STC)，技術傳播和技術寫作職業大約在第二次世界大戰時期被首次提及[1]，當時技術文檔由於軍事目的而成為必要。技術寫作職位名稱於第二次世界大戰期間在美國出現[4]，即使直到 1951 年才發布了第一則「Help Wanted: Technical Writer」招聘廣告。[5]事實上，直到 2010 年「Technical Writer」職位名稱才被加入到美國勞工統計局的《職業前景手冊》（Occupational Outlook Handbook）。[6]20 世紀 40 到 50 年代，技術傳播人員和寫作人員受僱為軍方編寫文檔，通常包括新型武器的詳細使用說明。還有些技術傳播人員和寫作人員為當時出現的新技術編寫文檔。根據 O'Hara 的描述：[7]

戰爭是科學和技術進步最重要的推動力。U.S. Army Medical Corps 在巴拿馬的叢林裡跟瘧疾作戰、Chemical Corps 推動了炸藥和有毒氣體（以及對它們的防護）領域的化學進步、Manhattan District of the Corps of Engineers 對物理學的理解有了巨大飛躍、Air Corps 成為航空設計的先驅。

在技術寫作職業發展的初期，大多數技術寫作人員跟寫作團隊一起在辦公室工作。跟現在的技術寫作人員一樣，他們開展一手資料搜集，並與主題專家面談以確保信息的準確。在第二次世界大戰期間，能夠遵從政府對於文檔的嚴格規範是技術寫作人員最重要的特徵之一。[7]二戰後，隨着新技術的興起（如計算機），技術寫作人員開始進入其它領域工作，編寫用戶手冊、快速參考指南、硬件安裝手冊、和速查手冊。[7]在二戰後的一段時期（1953-1961），技術傳播人員（包括技術寫作人員）變得熱衷於使領域「專業化」。[6]據 Malone 所述[6]，為了使領域專業化，技術傳播人員和寫作人員實行了一系列舉措：創建專業組織、形成一套專業的知識體系、推行技術傳播從業人員的道德標準、關於從業人員資格認證的討論、着手領域內教育項目的授權。

技術寫作職業不斷發展壯大。據 O'Hara 所述，寫作和編輯職業（包括技術寫作人員）的職位數量在 1994 到 2005 年間增長了 22%。[7]當今技術寫作人員的工作環境多種多樣。很多技術寫作人員使用 VPN 遠程工作，或通過在線門戶網站（如 Skype、Zoom）跟團隊溝通。有些技術寫作人員在辦公室工作，通過可在線存儲文檔的內容管理系統跟團隊共享內容。技術寫作人員的工作內容涵蓋了編寫政府報告、內部文檔、技術設備的使用說明、軟件或系統的嵌入式幫助、或其它技術文檔。技術的不斷發展將為技術寫作人員不斷拓展更多的可能性。很多技術寫作人員負責為移動應用程序和 Web 應用程序編寫技術文檔或嵌入式幫助文檔。他們還編寫僅用於在手持式設備上閱讀的內容，然而其中大部分作品不會像過去的技術文檔一樣被印刷成冊。

所需技能

除了要有紮實的調研、文案寫作、語言、寫作、和校訂技能外，技術寫作人員可能還具備以下方面的技能：

技術寫作人員也可以將這些技能應用到非技術內容的撰寫。技術寫作人員通常不是領域專家 (SME)，他們通過與 SME 面談和開展必要的調研來確保編寫和收集的內容在技術上是準確的。為了能充分理解主題，技術寫作人員需完成一手資料和二手資料收集。[來源請求]

特徵

一個專業的技術寫作人員能夠以簡潔、有效的方式編寫、理解、和傳達技術信息。他們可能專注於某個特定領域，但必須對所描寫的產品非常了解。例如，API 文檔寫作人員主要編寫 API 文檔，別的技術寫作人員則可能擅長電子商務、製造業、科學、或醫學資料。[8]

技術寫作人員從多個來源收集信息。他們的信息來源通常散布在組織的各個部門，可以從開發人員到市場營銷部門。

根據 Markel 的觀點[9]，好的技術文檔可以用 8 個特徵來衡量：真實、清晰、準確、全面、易於訪問、簡潔、看起來專業、正確。技術寫作人員致力於通過仔細研究使文檔符合這 8 個特徵。

角色和功能

要創建有效的技術文檔，寫作人員必須對這三個元素進行分析：讀者、目的、和使用場景。[10]這些元素之後就是文檔設計，它決定了讀者所看到的內容。

讀者分析

技術寫作人員力求將複雜的概念或過程簡化，使讀者能最大程度地理解這些內容。文檔的最終目標是幫助讀者找到他們需要的內容、理解這些內容、並恰當地使用這些內容。[11]要實現這個目標，技術寫作人員必須了解讀者是如何使用和閱讀文檔的。在一個文檔項目開始時進行讀者分析，有助於明確讀者對某一特定文檔的需求。

進行讀者分析時，技術寫作人員通常會提出以下問題：

  • 目標讀者是誰？
  • 他們有哪些特徵？
  • 讀者的職能是什麼？
  • 讀者對主題有何看法？
  • 讀者對信息發送者有何看法？
  • 讀者期待什麼形式的文檔？
  • 讀者的工作任務是什麼？
  • 讀者的知識水平如何？
  • 有哪些影響因素？

通過準確的讀者分析能夠獲得一套準則，用來決定文檔的內容、設計和呈現形式（在線幫助、交互式網站、手冊等）、以及語氣和知識水平。

目的

技術寫作人員通過分析信息的目的或功能來了解文檔須達成的目標。通過確定信息的目的（例如旨在說服讀者「以某種方式思考或行動、使他們能夠完成某項任務、幫助他們理解某事物、改變他們的態度」），來指導寫作人員如何設計版面、以及選擇哪種文檔類型（在線幫助、白皮書、建議書等）。

使用場景

使用場景是指讀者使用信息時所處的物理和時間環境，例如：在他們的辦公桌前、在某個工廠里、在生意不景氣的夏季、或公司正處於危機當中。了解使用場景讓技術寫作人員知道讀者如何使用這些信息。這些知識將會對寫作人員設計信息的版面產生重大影響。例如，如果文檔是關於一艘小型船舶的故障快速處理指南，寫作人員可能採用頁面覆膜工藝以增加使用壽命。

文檔設計

收集完以上信息，文檔具有最佳的可讀性和可用性。根據某專家的觀點，技術寫作人員使用 6 大策略來設計和編寫技術內容：布局、重點、清晰、簡潔、風格、和可信度。

布局：對可視元素進行排序和組織，以便讀者能夠看到他們的結構：他們是如何分組連貫、如何相互區別。在考慮布局時，技術寫作人員着眼於如何使用標題、列表、圖表、和圖片來提高可用性。
重點：文檔如何通過突出或加強來展現重要內容。技術寫作人員通過擺放位置、粗體、顏色、和字號的斟酌來向讀者展示重要信息、警告、有用的提示等。
清晰：該策略幫助接收者快速、完整地理解信息，並在必要時果斷地做出反應。技術寫作人員力求減少視覺噪音，例如低對比度、過於複雜的圖表或圖片、不能辨認的字體，這些都會妨礙讀者對信息的理解。
簡潔：該策略考量的是設計上的「視覺膨脹和雜亂」，例如標題和列表的數量、線條和方框、繪圖的細節和數據統計圖表、字體變化、過分修飾、和字符間距。技術寫作人員必須考慮到所有這些設計元素，以確保讀者能容易地使用文檔。
風格：某個文檔給人的印象或感覺。文檔內容應該正式和專業，還是應該輕鬆和幽默，這取決於文檔的類型和讀者。除了語言之外，技術寫作人員還可以通過使用間隔、圖片、字體等來設定技術內容的風格。
可信度：視覺語言在文檔中所獲得的可信度。技術寫作人員應致力於創建專業、沒有錯誤的文檔以建立讀者的信任感。

所需條件

技術寫作人員有多種職位名稱，包括 technical writer、technical communicator、information developer、technical content developer、technical documentation specialist。在 United Kingdom 和其他一些國家，技術寫作人員通常被稱為 technical author 或 knowledge author。

技術寫作人員通常同時具備技術背景和寫作技能。他們通常擁有某個技術領域的學位，但可能還具備新聞寫作、商務或其它領域的學位。許多技術寫作人員是從別的領域（例如新聞寫作或技術領域）轉行做技術寫作的，通常在他們參加技術傳播（technical communication）相關課程、學習到所需技能後。

方法學（文檔開發生命周期）

在開始撰寫技術文檔之前，技術寫作人員必須理解文檔的主題、目標、和讀者。他們通過學習現有資料、與 SME 面談、以及實際使用產品來收集信息。他們對讀者進行研究，以了解他們的需求和對技術的理解水平。

技術出版物的開發生命周期通常包含 5 個階段，與產品開發計劃相一致：[12]

  • 階段 1：信息收集和規劃
  • 階段 2：內容計劃書
  • 階段 3：內容開發和實施
  • 階段 4：發布
  • 階段 5：評估

文檔開發生命周期通常包含 6 個階段（各個組織可能有所不同）。

  1. 受眾分析（確定目標讀者）
  2. 用戶任務分析（基於目標讀者的任務和信息分析）
  3. 信息架構（基於分析的設計、如何準備文檔）
  4. 內容開發（開發/準備文檔）
  5. 技術審核和編輯審核（上級人員審核，如部門經理等）
  6. 排版和發布（發布文檔）

這與軟件開發生命周期相似。

好的技術文檔通常遵循一套正式的標準或規範。技術文檔具有多種風格和形式，取決於傳播媒介和主題領域。印刷和在線文檔雖然在許多方面不同，但在文字、信息結構、和布局上仍遵循基本相同的規範。技術寫作人員通常遵循某個標準風格指南中的格式約定。在美國，技術寫作人員通常遵循 The Associated Press Stylebook 或 the Chicago Manual of Style (CMS)。許多公司都有企業內部的風格指南，其中涵蓋了企業標識的使用、品牌推廣、以及企業風格的其他方面。Microsoft Manual of Style for Technical Publications 是這些風格指南中的典型代表。

工程類項目，特別是國防和航天相關項目，通常遵循國家和國際文檔標準，例如針對民航機的 ATA100，或針對民用和軍事防禦平台的 S1000D。

環境

技術寫作人員通常是某個寫作團隊或項目開發團隊中的一員。通常情況下，寫作人員在完成初稿後，將其提交給一個或多個 SME 進行技術審核，以驗證內容準確性和完整性。可能會由另一名寫作人員或編輯人員進行編輯審核，以檢查風格遵從、語法、和可讀性等。在某些情況下，寫作人員或其他人會請讀者來測試文檔，以改進文檔可用性。文檔的最終發布通常需遵照檢查清單，以確保發布作品的質量和一致性。[13]

職業發展

對於技術寫作人員來說，沒有一個標準的職業通道，但他們中的部分人可能進入項目管理領域。有些寫作人員可能晉升到高級技術寫作人員的職位，處理複雜的項目或帶領一個由寫作人員和編輯人員組成的小團隊。在大型組織中，一個 documentation manager 可能同時管理多個項目和團隊。

技術寫作人員還可能在獲得某個特定技術領域的專業知識後，轉行到相關的職業，例如軟件質量分析或業務分析。有些技術寫作人員在成為某領域的主題專家 (SME) 後，可能會轉型到該領域工作。技術寫作人員通常編寫相關技術的培訓資料，包括課堂指南和在線學習 (e-learning)，其中某些技術寫作人員轉型成為職業培訓師 (Professional Trainer) 和教學設計師 (Instructional Designer)。

具有寫作技巧專業知識的技術寫作人員能進入印刷媒體或電子媒體公司，從而獲得賺取更多收入或改善工作條件的潛在機會。

美國勞工部 (U.S Department of Labor) 預計從 2016 到 2026 年技術寫作人員的僱傭人數將增長 11%，略高於所有職業的平均增長率。他們預期工作機會是相當不錯的，尤其是對於具備技術技能的申請者。美國勞工統計局還指出，「科學和技術產品」的發展以及「基於 Web 的產品支持」對技術寫作人員的需求將刺激需求量的增長。 [14]

著名的技術寫作人員

  • William Gaddis，著有 J R (1975) 和 A Frolic of His Own (1994)。在他的第一部小說 The Recognitions (1955) 獲評欠佳後，在 Pfizer 和 Eastman Kodak 等公司擔任技術寫作人員達 15 年。[15]
  • Gordon Graham，白皮書方面的專家、寫作教授。
  • Dan Jones，大學教授、Society for Technical Communication 會員。
  • Robert M. Pirsig，著有 Zen and the Art of Motorcycle Maintenance: An Inquiry into Values (ZAMM) (1974)。在撰寫這部暢銷書籍的同時為 IBM 編寫技術手冊。
  • Thomas Pynchon，美國作家，著有 The Crying of Lot 49 (1966)、Gravity's Rainbow (1973)、以及 Mason & Dixon (1997) 等作品。從 1960 到 1963 年在波音公司擔任技術寫作人員，期間同時完成了他的第一部小說 V. (1963)。
  • Richard Wilbur，美國詩人。他在談話中提到曾任職於波音公司。
  • George Saunders，美國作家，著有 Tenth of December: Stories (2013)，以及短篇小說集、散文、和中篇小說。在 Radian International 公司（位於 Rochester, New York 的一家環保工程企業）擔任技術寫作人員和地質工程師職位時，完成了他的第一部短篇小說集 CivilWarLand in Bad Decline (1996)。
  • Amy Tan，美國作家，著有 The Joy Luck Club (1998)、The Bonesetters Daughter (2001)、以及其他備受好評的小說。Tan 在擔任技術寫作人員時開始寫小說。[16]
  • Marcia Wilbur，美國作家，著有 A Decade of the DMCA。在創作此書時為 Microchip 公司編寫技術文檔。

參見

參考文獻

  1. ^ 1.0 1.1 L. Lin. (2017, November). What is technical writing? [Web log post]. Retrieved from http://www.stc-psc.org/what-is-technical-writing/ （頁面存檔備份，存於網際網路檔案館）
  2. ^ Gary Blake and Robert W. Bly, The Elements of Technical Writing, pg. 3. New York: Macmillan Publishers, 1993. ISBN 0020130856
  3. ^ Technical Writers Thriving in 2020 （頁面存檔備份，存於網際網路檔案館）, presentation at ITTT 2014 forum
  4. ^ O'Hara, F.M. (2001). A brief history of technical communication. In STC’s 48th Annual Conference Proceedings (pp. 500–504.)Arlington, VA: Society for Technical Communication.
  5. ^ History of technical writing. [Webpage].Retrieved from http://www.proedit.com/history-of-technical-writing/ （頁面存檔備份，存於網際網路檔案館）
  6. ^ 6.0 6.1 6.2 Malone, E. A. (2011). The first wave (1953–1961) of the professionalization movement in technical communication. Technical Communication, 58(4),285-306. Retrieved from https://www.stc.org/techcomm/ （頁面存檔備份，存於網際網路檔案館）
  7. ^ 7.0 7.1 7.2 7.3 O'Hara, F.M. (2001). A brief history of technical communication. In STC’s 48th Annual Conference Proceedings (pp. 500–504.)Arlington, VA: Society for Technical Communication.
  8. ^ What Does a Technical Writer Do? （頁面存檔備份，存於網際網路檔案館） Wisegeek, Copyright © 2003 - 2013. Retrieved 31 October 2013.
  9. ^ Markel, M. (2015). Introduction to technical communication. In Technical Communication (pp. 7-9). Boston: Bedford/St. Martin's
  10. ^ Kostelnick, Charles. Designing Visual Language. New York, NY: Longman. 2011: 3–390. ISBN 978-0-205-61640-4. 
  11. ^ Riordan, Daniel. Technical Report Writing Today. Boston, MA: Wadsworth Cengage Learning. 2005: 1–546. ISBN 978-0-618-43389-6. 
  12. ^ Hackos, JoAnn T. Managing Your Documentation Projects. Wiley. 1994: 630. ISBN 0-471-59099-1. 
  13. ^ Tarutz, Judith A. Technical Editing. New York: Perseus Books. 1992: 456. ISBN 0-201-56356-8. 
  14. ^ Bureau of Labor Statistics, U.S. Department of Labor, Occupational Outlook Handbook, Technical Writers, on the Internet at https://www.bls.gov/ooh/media-and-communication/technical-writers.htm （頁面存檔備份，存於網際網路檔案館） (visited February 22, 2018).
  15. ^ Gaddis, William, 1922-. [2015-01-11]. （原始內容存檔於2015-04-02）. 
  16. ^ Amy Tan Biography. Encyclopedia of World Biography. [2016-10-07]. （原始內容存檔於2021-02-19）. 

外部連結

取自「https://zh.wikipedia.org/w/index.php?title=技术写作人员&oldid=84490967」