如何提升你的技術寫作技能?
How to improve your technical writing skills?

技術寫作到底是什么?

技術寫作是一種針對特定主題的寫作形式,需要提供指導、說明或解釋。這種寫作風格具有獨特的目的,因此與其他類型的寫作(如創意寫作、學術寫作或商業寫作)有著截然不同的特質。它是一種專注於將複雜資訊傳達給需要這些資訊以完成特定任務或達成特定目標的人的寫作專業。技術寫作經常被形容為「將困難的事物簡化」因此而得名。它也是技術溝通的一個分支,主要應用於技術與運營領域,包括數位科技、工程、科學、航空、機器人、金融、醫學、電子、林業和生物技術。

圖片來源:@Nick Morrison

技術寫作的主要類型有哪些?

技術報告
除了說明與指導外,許多產品還會提供有關產品開發、結構變更和運作變更的詳細資訊。為了確保準確性和清晰度,技術寫作者會整理並編輯這些內容。

規則與法規
各規模的企業都需要明確的政策與程序來規範其運作。他們也利用員工手冊來防範員工因聲稱不瞭解某些規則與法規而提起的訴訟。

商業規劃
金融機構在向新創企業或已成立的公司貸款前,需要詳細的商業策略。這些文件需要進行廣泛且高度專業的研究,並深入理解公司的財務與營運狀況,包括支出預測、潛在損失與利潤空間。同時還需進行競爭分析、行銷策略,以及對負責人職業背景與財務狀況的深入資料調查。

文獻回顧
文獻回顧可包含在較大的報告中,也可作為獨立文件使用。它是一種技術寫作形式,用以列出某一主題目前的知識狀態。文獻回顧會突出顯示研究里程碑、相互矛盾的發現,以及需要透過進一步研究才能了解的內容,同時也總結並解釋某一主題上先前的研究與發現。

終端使用者指南
當您購買軟體、安裝電腦組件或購買這些產品之一時,會附上說明如何使用數位裝置或消費性電器的使用者手冊。這些被稱為終端使用者說明,但此類別還包括故障排除手冊、組裝說明、「該做與不該做」清單、保固資訊以及法律聲明等文件。

我們如何提升技術寫作技能?

  1. 建立大綱
    為了幫助你了解在工作中需要涵蓋哪些內容,我們建議建立大綱。在進行研究時,這也有助於識別知識上的缺口。當撰寫白皮書或案例研究等長篇內容時,大綱可作為提醒你需涵蓋內容的工具。也可以使用範本代替大綱。例如,商業計畫遵循某些業界認可的標準,包含執行長概覽、競爭對手分析等要素。
  2. 將可讀性放在首位
    技術寫作並非創意寫作,因為其目的在於指導而非激發或娛樂。在撰寫困難主題時,讓你的作品更易閱讀會有幫助。
  3. 了解你的受眾
    了解你的受眾至關重要,尤其是在撰寫技術資訊時。你可以根據預期閱讀你文章的受眾,調整用詞、語氣與敘述方式。
  4. 加入圖像
  5. 在技術寫作中加入圖像更像是一項必要條件而非奢侈。圖解、圖片與流程圖能為文字過多的內容注入一些急需的輕鬆感。

欲了解更多信息……

閱讀以下書籍,以了解更多有關技術寫作的內容!