淺談設計技術性文章 – Technical writing for engineers and scientists

最近, 在寫技術性文章 / 計劃書 / 產品介紹 / 報告 時發覺, 
GOOGLE 竟然找不到一個好方法.
之後就去請教一位英文教授, 在他那裹借來了一本書
<<Pocket Book of Technical Writing - for Engineers and Scientists 2nd>>.
清楚易明簡潔地令你明白如何開筆, 一份技術性文章應該如何設計和應用什麼表達方式.
相信作為工程師 / 科學人員, 每天醉心於研究的你們, 
在表達自己成果的時侯都會跟我有同樣的煩惱.

從這本書了解到, 寫技術性文章約有四大部份

  1. 文章的目的和針對讀者
  2. 針對技術性文章的特點
    1. 技術性話題
    2. 多用圖形 / 圖畫表達
    3. 數字資料以表達數量與方向
    4. 由淺至深, 準確的表達方式
  3. 決定文章性質
    1. 計劃書
    2. 報告
    3. 研究報告
    4. 說明書
    5. 建議書
  4. 選擇不同部份的表達方式
    1. 說明名詞的含意 (classify terms)
    2. 結構性陳述 (Description of mechanism)
    3. 流程性陳述 (Description of Process)
    4. 圖表 (Visual)

本文以計劃書作為例子

一般的計劃書格式有時過於複雜, 
<<Pocket Book of Technical Writing - for Engineers and Scientists 2nd>> 
中建議了另一種計劃書格式 (Informal Proposals)

Informal Proposals

Introduction
  • Purpose - Describe the reason for writing this proposal (文章目的)
  • Background - Describe the problem that needs to be solved (問題背境)
  • Scope - Review what this proposal will and will not cover (文章範圍)
Discussion
  • Approach - Describe the proposed solution to the problem (解決方案)
  • Result - Show how the solution will solve the problem(成效)
  • Statement of work - List the tasks that will be performed (步驟)
Resources
  • Personnel - List those who will be doing the work and their qualifications (人才)
  • Facilities/equipment - List the physical resources required to do the work (資源)
Costs
  • Fiscal - List the financial costs of implementing the proposed solution (成本)
  • Time - List the time required to implement the proposed solution (時間)
Conclusion
  • Summary - Highlight the benefits and risks of adopting the proposal (總結)
  • Contract - Provide a contact for more information (聯絡)

以下是一些個人經驗

在落筆的時侯, 我們需要記住 – 文章是用來服侍讀者的 ! We are serving readers.

Introduction
在表達方式方面, 第一部份introduction 需要針對目標讀者, 使用較有吸引力的字句. 並在 scope 中說明這份計劃書只包括他們有興趣的話題.

Discussion
Approach 這部份是文章的中心, 建議在這裹運用一些技巧 (Description of mechanism / Process, part by part description). 而且需要加上圖表, 因為讀者都是懶惰的, 技術文章最大可能給讀者留意到的就是圖表.
在這裹可以用些圖片, 例如系統結構, 方便讀者明白.
到 statement of work 這部份時, 因為在顯示步驟, 請用 point form 表達.

Resource / Costs
在這些部份都是說明一些跟時間金錢有關的東西, 所以必要用圖表 / 計算表等東西來表達. 切記在金額上加上貸幣名 (HK$ / NT$)

Conclusion
這部份就是文章的概括, 有時一些比較忙的老闆可能就只看這一部份. 所以在這裹說話可以修飾得漂亮一點.
最後, 當然是在 contract 部份留下你的大名.

Visuals
多用圖表如 計算表 / 流程表 / 設計圖 / 結構圖 在什麼時候都有利 !