跳至內容

技術寫作

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

技術寫作是技術傳播內容的寫作，可應用於各種技術和專業領域，例如計算機硬體和軟體、工程學、化學、航空工程、機器人學、金融、醫學、消費電子產品、和生物技術。技術寫作是技術傳播領域最大的一個分支。[1]

美國技術傳播協會（Society for Technical Communication）將技術傳播定義為各種形式的傳播，它們具備以下特徵：(1) 關於技術或專門的主題，例如計算機應用程式、醫療流程、或環境保護法規；(2) 使用印刷文檔或技術手段進行傳播，例如網頁、幫助文件、或社交媒體網站；(3) 提供如何做某事的指導說明，無論任務的技術成程度如何。 [2]

概述

技術寫作由技術寫作人員（或技術資料編寫者）完成、是一個在專業場所編寫和共享信息的過程。[3]:4技術寫作人員的首要任務是以最明確、有效的方式將信息（通常是複雜的信息）傳達給另一個人或另一方。[3]:4分析信息並以易於閱讀和理解的格式呈現信息是他們的主要任務之一。[3]:12–14一個好的技術寫作人員需要很強的寫作和溝通技巧。他們不僅通過文字傳達信息，還必須熟練使用計算機。例如，使用各種軟體程序來創建和編輯插畫，使用圖表製作軟體創建視覺輔助，以及使用文檔處理軟體來設計、創建文檔。[4]

雖然通常跟在線幫助和用戶手冊聯繫在一起，技術寫作涵蓋多種文檔類型和技術手段。新聞稿、備忘錄、商業計劃書、數據手冊、產品描述和設計規範、白皮書、個人簡歷、和工作申請函，這些只是技術寫作中的一小部分。[5]

發展歷史

雖然技術寫作在第二次世界大戰後才被公認為是一個正式的職業，[6]:2但它的起源可追溯到古典時期。[7]:233評論家們認為，亞里斯多德等作家的作品是最早的技術寫作形式。[7]:234傑弗里·喬叟的《論星盤》(Treatise on the Astrolabe) 一書是技術文檔的最早範例，也被認為是第一篇用英文出版的技術文檔。[8]

隨著機械式印刷機的發明、文藝復興開始、以及啟蒙時代的興起，用文件記錄研究結果變成一個必然需求。艾薩克·牛頓和李奧納多·達·文西等科學家和發明家紛紛用文檔記錄了他們的發明和研究結果。[6]:1 這些文檔雖然在其發行時期不叫做技術文檔，但對於發展現代形式的技術溝通和寫作起到了至關重要的作用。[6]

在工業革命期間，技術溝通領域進一步發展。[9]:3隨著新機器的發明和使用，指導人們使用這些越來越複雜的機器的需求不斷增加。[9]:8然而跟過去口頭傳下來的技能不同，除發明者之外，沒有人知道如何使用這些新設備。因此寫作成為傳播信息最快、最有效的方式，能用文檔描述這些設備的寫作人員成為一種渴求。[9]

在 20 世紀，技術寫作的需求猛升，技術寫作職業也終於被正式承認。第一次世界大戰和第二次世界大戰推進了醫學、武器裝備、計算機科學、和航空航天技術的發展。[6]:2 技術的快速發展、再加上戰爭的緊迫性，迫切需要用設計精良的文檔來記錄這些技術的使用方法。技術寫作在這一時期的需求量很大，並在第二次世界大戰期間成為一個正式的職位。[6]:1

第二次世界大戰之後，技術的發展促進了生活消費品和生活水平的提升。[6]:3在戰後繁榮時期，公共服務（例如圖書館和大學）以及交通系統（例如公交車和公路）發展迅猛，需要越來越多的寫作人員來記錄這些過程。[6]:1同樣在這個時期，計算機開始在大型企業和大學使用。值得一提的是，在 1949 年，Joseph D. Chapline 編寫了第一篇計算機技術文檔，它是 BINAC 計算機的使用手冊。 [10]

1947 年電晶體的發現使計算機的製造成本比以往任何時候都要低。[6]:3 更便宜的價格意味著個人和小型企業也能購買計算機。[6]:3由於計算機變得越來越重要，對能夠用文檔描述這些設備的寫作人員的需求也不斷增長。[6]:3在 20 世紀 70 和 80 年代，隨著消費電子產品進入越來越多的家庭，技術寫作職業得到進一步發展。[6]

近年來，計算機在社會中的突出地位推進了數字溝通領域的諸多發展，技術寫作人員使用的工具也有了很大變化。[6]:3超文本、文字處理軟體、繪圖軟體、以及排版軟體使得技術文檔的創建變得比以往任何時候更快、更容易，現在的技術寫作人員必須熟練使用這些軟體。[3]:8–9

技能

技術寫作人員需要具備多種技能，例如：[11]

  • 優秀的書面語言能力
  • 對事物是如何工作的抱有好奇心
  • 面談技巧
  • 平面設計知識
  • 計劃和分析能力
  • 傳播信息的能力
  • 有邏輯地組織信息

好的技術寫作要求簡潔、目標明確、易於理解、沒有錯誤、並且以讀者為中心。[12]:7技術寫作人員應使文檔儘可能表達明確、避免使用行業術語，語言風格方面應避免被動語態和名詞化（即把動詞、形容詞轉換為名詞使用）。[3]:236–245由於要應用於真實的場景，技術文檔應明確文檔主題是什麼，以及讀者應該做什麼。以描述如何使用大功率 X 射線機的使用說明書為例，如果內容晦澀難懂，可能會導致嚴重的後果。

技術寫作要求寫作人員對其讀者做大量研究。[3]:84–114技術寫作人員需要知道讀者對所討論內容的了解程度，因為讀者的知識庫將決定文檔的內容和重點。[3]:84–114例如寫給一群高水平科學家的討論某科學研究成果的評估報告，跟寫給普通大眾的將大不相同。技術寫作人員本身不需要是主題專家 (SME)，當某項工作需要對主題具備更多知識時，他們通常與主題專家共同協作來完成。[3]:51

技術寫作必須準確。在分析讀者之後，技術寫作人員必須知道要傳達什麼內容，然後以準確、適當的方式傳達信息。如果寫作人員表達的信息不準確，可能會造成人身傷害、環境或財產方面的損失。了解讀者對保證準確性很重要，因為文檔語言需要根據讀者對主題的了解程度進行調整。例如編寫如何正確、安全搭建書架的使用說明書，應確保任何人都可以跟著操作，而且要求精確到細節（如每個緊固件的具體位置）。如果這些說明不準確，可能會導致書架安裝不穩或無法安裝。[13]

文檔的設計和版面也是技術寫作非常重要的組成部分。[3]:261–286技術寫作人員在文檔的可讀性上投入大量時間，因為設計糟糕的文檔會妨礙讀者對內容的理解。恰當使用文檔設計元素對技術文檔尤其重要，如項目符號、字體大小、和粗體。[14]技術寫作人員經常使用圖片、圖表和視頻，因為對於傳達複雜的信息（例如公司的年度收益或產品的設計特性），這些媒體元素遠遠比文字描述要有效的多。[3]:306–307

技術文檔

技術寫作涉及多種類型和寫作風格（取決於信息和讀者）。[3]:84–114不僅僅只有技術寫作人員創建技術文檔，在專業環境中工作的幾乎所有人都創建某種類型的技術文檔。以下是技術寫作的一些例子：

  • 使用說明和操作步驟是幫助開發人員或終端用戶操作或配置某個設備或程序的文檔。[12]:226以下產品的用戶手冊和故障排除指南是使用說明文檔的一些範例：電腦程式、計算機硬體、家用產品、醫療設備、機械產品和汽車。
  • 商業計劃書是描述項目目的、項目中要完成的任務、完成項目的方法、以及項目成本的文檔。大多數項目從商業計劃書開始。[12]:191它包含多種多樣的主題。例如，技術寫作人員可能編寫商業計劃書來描述安裝新的計算機系統所需的成本，營銷專員可能寫商業計劃書來描述產品系列，教師可能編寫商業計劃書來說明新開設的生物課是如何安排的。
  • 電子郵件、信件、和備忘錄是一些最常見的商業書面文檔。[12]:117信件和電子郵件可用於多種目的：有些簡單地用於傳達信息，而有些是為了說服收信人完成某項特定工作。信件通常是寫給公司以外的人，備忘錄是寫給同公司其他員工的文檔。[12]:118
  • 新聞稿。當一個公司想要向公眾披露某個新產品或服務，他們會僱傭技術寫作人員撰寫一篇新聞稿。該新聞稿旨在描述產品的功能以及能為公眾帶來哪些價值。[15]
  • 設計規範是描述某個物品的結構、組成部分、包裝、和交付物的設計要點，它提供足夠詳細的信息以使另一方能夠重建。[16]例如，技術寫作人員可能用文字和圖表的方式編寫某智慧型手機或自行車的規格書，以便製造商能夠製造出該物品。
  • 描述是對程序和過程的簡單描述，以幫助讀者理解某個事物是如何工作的。[3]:564例如，技術寫作人員編寫文檔來描述溫室效應，或用來說明自行車的剎車系統是如何工作的。
  • 個人簡歷和工作申請函也屬於技術文檔的範疇[12]:284–285，用於向讀者展示文檔作者的個人背景和資歷。
  • 技術報告用來向讀者提供信息、操作指南、和任務分析。[12]:141–143報告的形式多種多樣。例如，技術寫作人員評估一棟在售的建築，並編寫考察報告來描述他/她的考察結果、以及他/她是否認為應該購買該建築；為某個非盈利組織工作的寫作人員可能發表了一篇評估報告，用於展示該組織關於空氣污染的研究成果。
  • 案例研究是關於被研究的個人、團體或情況（也可能是出於了解某事物的目的，對現實生活中的某個情況進行觀察或研究）的報告。[17]例如，某人在他/她的工作場所遇到的挑戰，以及他/她是如何解決的，這就是案例研究。
  • 白皮書是寫給領域專家的文檔，通常描述技術或商業方面的某個解決方案。[12]:644例如，描述如何使企業從市場中脫穎而出的文章，或解釋企業如何防止網絡攻擊的文章，這些都屬於白皮書。
  • 網站。超文本的出現改變了文檔閱讀、組織和訪問的方式。當今的技術寫作人員通常負責編寫網站頁面，例如「關於我們」或產品頁面，並要求熟練掌握 Web 開發工具。[18]:484–504
  • 數據手冊是關於產品、機器、設備、軟體、應用程式、或系統的性能、關鍵指標、技術特性、應用電路和其它重要信息的簡要概述。
  • API 指南是為開發者社區編寫的用來說明應用程式接口的文檔。

工具

技術寫作人員使用以下工具來編寫和呈現文檔：

  • 桌面出版工具或文字處理工具。技術寫作人員使用文字處理工具（例如 Scrivener、Microsoft Word、Apple Pages、LibreOffice Writer）來編寫、編輯、設計和列印文檔。對於技術寫作來說，頁面布局跟寫作語言同樣重要，因此技術寫作人員還使用專業的桌面排版工具（例如 Adobe InDesign 和 LyX）。[19] 這些軟體跟文字處理工具的功能相似，但提供更多文檔設計的功能，並使大量排版工作自動化。[20]
  • 幫助文件製作工具被技術寫作人員用來創建幫助系統。幫助文件與軟體產品一起提供，可通過網頁瀏覽器訪問或以文件形式提供給用戶在電腦上查看。 [21] Madcap Flare 和 Adobe Framemaker 是常用的幫助文件製作工具。
  • 繪圖軟體。通常，圖片和其它視覺元素能夠比文本段落更好地描繪信息。[3]:306–307技術寫作人員使用 Adobe Photoshop 和 GIMP 等繪圖軟體來創建和編輯文檔的視覺部分，例如照片、圖標、和圖表。
  • 協同軟體。技術寫作常常涉及不同公司間的多方溝通，是一種協作性事務。[3]:57因此，技術寫作人員使用 Wiki 系統和共享的文檔工作區來與其他寫作人員和公司協同創建技術文檔。[3]:74
  • Web 開發工具。技術寫作人員的工作已不再局限於創建文檔。他們還必須為公司的企業網站和其它專業網站提供內容。[18]:485 Web 開發工具（例如 Adobe Dreamweaver）是技術寫作人員要求熟練掌握的行業標準工具。
  • 圖形軟體。技術寫作人員使用圖形和流程圖來描繪統計信息（例如餐廳的訪問人數，或某大學花在體育項目上的經費）。[3]:306–307 雖然可以使用 Microsoft Excel 和 Word 等軟體來創建基礎的圖形和圖表，有些時候技術寫作人員必須製作極為複雜和詳細的圖形，而這些圖形需要用到這些軟體以外的功能。在這種情況下，通過強大的繪圖軟體（例如 Microsoft Visio）可以有效地組織和設計圖形和圖表。[22]
  • 截屏工具。技術寫作人員通常使用 Camtasia 和 Snagit 等截屏工具來截取桌面。[23][4]如果為計算機軟體編寫使用說明，對寫作人員來說，將他們自己完成某個任務的過程錄製下來比撰寫一連串很長的說明要容易的多。截屏工具還能對電腦上運行的軟體進行截圖。

技術寫作相關協會

  • Association for Business Communication
  • Czech Society for Technical Communication
  • European Association for Technical Communication
  • IEEE Professional Communication Society
  • Institute of Scientific and Technical Communicators
  • International Association of Business Communicators
  • SIGDOC
  • Society for Technical Communication
  • Korea Technical Communications Association
  • COM&TEC[24]

參見

參考文獻

  1. ^ What is Technical Communications? （頁面存檔備份，存於網際網路檔案館） TechWhirl. Accessed December 9, 2014.
  2. ^ Defining Technical Communication. Society for Technical Communication. [May 9, 2014]. （原始內容存檔於2011-02-15）. 
  3. ^ 3.00 3.01 3.02 3.03 3.04 3.05 3.06 3.07 3.08 3.09 3.10 3.11 3.12 3.13 3.14 3.15 Mike Markel. Technical Communication 10th Edition. Bedford/St. Martins. 2012. 
  4. ^ 4.0 4.1 Johnson, Tom. What Tools Do Technical Writers Use. I'd Rather Be Writing. December 19, 2011 [May 4, 2014]. （原始內容存檔於2020-11-11）. 
  5. ^ Perelman, Leslie C.; Barrett, Edward; Paradis James. Document Types. The Mayfield Handbook of Technical & Scientific Writing. [May 4, 2014]. （原始內容存檔於2021-02-13）. 
  6. ^ 6.00 6.01 6.02 6.03 6.04 6.05 6.06 6.07 6.08 6.09 6.10 6.11 O'Hara, Fredrick M. Jr. A Brief History of Technical Communication (PDF). Montana State University Billings. [April 22, 2014]. （原始內容 (PDF)存檔於2012-09-07）. 
  7. ^ 7.0 7.1 Doody, Aude; Follinger, Sabine; Taub, Liba. Structures and Strategies in Ancient Greek and Roman Technical Writing: An Introduction (PDF). Studies in History and Philosophy of Science (University Of Cambridge). February 8, 2012, 43 (2) [April 22, 2014]. （原始內容 (PDF)存檔於August 3, 2012）. 
  8. ^ The Way to the Stars: Build Your Own Astrolabe. Saint John's College. [April 22, 2014]. （原始內容存檔於2021-03-18）. 
  9. ^ 9.0 9.1 9.2 Crabbe, Stephen. Constructing a Contextual History of English Language Technical Writing (PDF). University of Portsmouth. 2012 [April 30, 2014]. （原始內容 (PDF)存檔於May 12, 2014）. 
  10. ^ History of Technical Writing. Proedit. [May 9, 2014]. （原始內容存檔於2020-10-20）. 
  11. ^ Technical Writer Career Information (PDF). Institute of Scientific and Technical Communicators (ISTC). [2018-07-24]. （原始內容 (PDF)存檔於2016-03-04）. 
  12. ^ 12.0 12.1 12.2 12.3 12.4 12.5 12.6 12.7 Tebeaux, Elizabeth; Dragga, Sam. The Essentials of Technical Communication. Oxford University Press. 2010. 
  13. ^ Diane Martinez, et. al., "Technical Writing: A Comprehensive Resource of Technical Writers at All Levels."
  14. ^ Waller, Rob. What Makes a Good Document? The Criteria we use (PDF). The University of Reading. April 2011: 16–19 [May 4, 2014]. （原始內容存檔 (PDF)於2021-02-02）. 
  15. ^ Perelman, Leslie C., Barrett, Edward, and Paradis James. "Press jaylan peregrino". （頁面存檔備份，存於網際網路檔案館） The Mayfield grave naba Handbook of Technical & Scientific Writing. Retrieved May 4, 2014.
  16. ^ Perelman, Leslie C., Barrett, Edward, and Paradis James. "Specifications." （頁面存檔備份，存於網際網路檔案館） The Mayfield Handbook of Technical & Scientific Writing. Retrieved May 4, 2014.
  17. ^ Dictionary and Thesaurus | Merriam-Webster. www.merriam-webster.com. [2016-01-22]. （原始內容存檔於2015-12-22）. 
  18. ^ 18.0 18.1 Anderson, Paul V. Technical Communication [A Reader-Centered Approach] 6th Edition. Thompson Wadsworth. 2007. 
  19. ^ Johnson, Tom "What Tools Do Technical Writers Use". （頁面存檔備份，存於網際網路檔案館） I'd Rather Be Writing. December 19, 2011. Retrieved May 4, 2014.
  20. ^ "What is LyX" （頁面存檔備份，存於網際網路檔案館）. LyX. Retrieved May 9, 2014.
  21. ^ "Overview of Help Authoring Tools" （頁面存檔備份，存於網際網路檔案館）. HelpnDoc. retrieved May 7, 2014.
  22. ^ Hewitt, John. How Technical Writer's use Microsoft Visio. Poe War. January 18, 2005 [May 9, 2014]. （原始內容存檔於May 12, 2014）. 
  23. ^ Brierley, Sean. Screen Captures 102 (PDF). STC Carolina (報告). 2002: 5–8 [May 9, 2014]. （原始內容 (PDF)存檔於2016-08-07）. 
  24. ^ Home. [2016-03-24]. （原始內容存檔於2016-04-08）. 

外部連結

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