//Logo Image
作者:徐業良(2004-06-20);推薦:徐業良(2000-06-21)

技術報告撰寫的基本原則

1.     技術報告格式的訂定

撰寫技術報告之前,首先要訂定技術報告的格式。在這個資訊爆炸的時代裡,資訊接受者往往習慣於以快速瀏覽的方式搜尋所要的資訊,而各種資訊型態中,文字可能是最容易讓資訊接受者“失去耐性”的一種資訊型態。一篇技術報告即使文字內容非常有內涵,如果不能有分明的段落,讓讀者一開始便能快速、清晰地掌握報告內涵,恐怕讀者根本不會有意願或耐性深入閱讀這份報告。

所以技術報告呈現的格式應該十分講究,何時用大標題、何時用小標題、標題編號的方式,內文字體的大小、段落的間隔、何時用黑體字、斜體字、何時要內縮,乃至於圖表及說明的格式等等,都應該要有明確、容易閱讀、且整篇一致的規則。對格式的講究並不是表面功夫,而應該視為文章寫作的一部份,事實上技術報告寫作上,“內容”與“格式”有同等重要的地位,作者用文字傳達所要表達的內容,也要思考如何用不同格式表達其每段文字在全文中的層次與定位,幫助讀者瞭解整篇文章的結構。

技術層面上,大部分書籍、期刊、網站,都有自行訂定的文件格式範本。研究機構、公司、學校、甚至個人,有撰寫大量技術報告的需求時,也建議先在文書處理軟體(如Word中)建立一個技術報告文件格式範本,明確定義標題、內文、表格、圖表等的格式,所有的技術報告採用明確而一致的格式,對於建立報告的專業感也有幫助。

2.     平行式思考的寫作方式

目前來說,大部分作者都是以電腦文書處理軟體當作寫作工具,事實上電腦對寫作的思考方式帶來了革命性的轉變。過去以手寫方式寫作或可稱為“序列式思考”的寫作方式,作者必須先在腦中構思好整篇文章的「起-承-轉-合」所有細節,再開始序列式地寫出。以電腦為寫作工具,寫作思考方式或可稱作“平行式思考”。作者可以不必序列式地構思整篇技術報告,而可以在技術報告要表達的幾個重點之間同步、平行地思考、寫作。

平行式思考可以讓寫作變得更有效率,作者不必等到整篇文章構思完成後才開始寫作,而可以先把構思比較成熟、材料比較完整的文字段落先行記載下來,這時也先不必花太多時間顧慮用字遣詞,或者文章的組織與結構。這些文字段落開始也許十分零散,但是累積足夠內容後,作者便可以利用電腦軟體將全文從頭編輯一次,包括修飾所用詞句,增添不足的內容,刪除重複或不相關的內容,調整文字段落順序,組織文章的結構,賦予不同文字段落應有的格式等。作者可以一次又一次地重頭編輯整篇文章,每次編輯都像是為文章“穿衣”,都可能有新的想法或素材為文章作更新,每次編輯對於文字內容和文章結構或格式的講究也越加細膩,直到交卷期限到了才停止。

有些作者還是習慣於先手寫草稿再逐字輸入電腦,這樣只把電腦當成“打字工具”,而非“寫作工具”,不能真正利用到以電腦平行式思考寫作的優勢。在平行式思考的寫作方式下,作者應直接利用電腦寫作,將“打字”也視為寫作的一部份,常有人覺得自己打字太慢,但是寫作速度的瓶頸絕對不在於打字,而是在寫作的思考,另一方面,打字速度絕對是可以經過練習增快的。

事實上在任何研究開發開始之初,我們就應該能期待研發最後的結果要以技術報告來呈現,因此在研究開發的過程中蒐集的資料、產生的想法、實驗的數據、乃至於各種工程圖面等,都應該習慣以一定格式用電腦檔案隨時記錄。這樣做除了知識保存與管理的意義外,研究開發的過程中紀錄的資訊,都是技術報告的內容,研究開發完成後,“寫報告”不應該是重新開始、額外的工作,而應該只是將這些內容加以編輯而已。

3.     技術報告的基本結構與標題訂定

儘管前面提到平行式思考的寫作方式,作者不必等到整篇文章構思完成後才開始寫作,但是一般習慣上技術報告或論文都還是有以下的基本結構:

摘要è簡介è文獻回顧è研究方法è研究結果è結論與討論

這樣的結構似乎可以套用在所有不同領域的技術報告,許多技術報告或論文的章節標題,往往也就完全依照這樣的名稱編排。但是章節標題訂定一個重要的原則是要有“敘述性”,讓讀者能夠望文生義,而對章節內容有所期待。像是「第一章 簡介」、「第二章 文獻回顧」這樣的標題可能太過籠統,「第一章 多重障礙者運動機能訓練科技輔具研發背景與目的」、「第二章 科技輔具研究文獻探討」便比較有敘述性。

除了各章節的標題外,技術報告本身的題目和摘要的“敘述性”可能更需要講究。現今以網際網路作資訊檢索的模式中,大量的技術報告儲存在資料庫中,讀者往往依據報告的題目和摘要檢索,閱讀摘要後再決定是否要閱讀這份報告。因此技術報告本身的題目和摘要往往是整個技術報告完成後才擬定的,希望更能夠扼要但完整地敘述報告內容。

技術報告或論文的題目必須在幾個字之內精簡地表達報告的內容,必須要包括被研究的主體(A)和研究的目的(B),例如「鋁合金輪圈(A)鑄造模擬分析(B)」、「防音防護具(A)舒適性能評估研究(B)」。有時也會在被研究的主體(A)或研究的目的(B)前面上加上一個形容詞,強調研究的特色(C),例如「可攜式(C)居家環境監測系統(A)之研發(B)」、「以模糊比例微分控制器(C)對軸對稱薄殼結構(A)做結構最佳化(B)」。

摘要要在一兩百字內表達技術報告的內容,吸引讀者繼續閱讀內文,也是技術論文中非常難寫的一部份。摘要應該簡短敘述技術報告中研究此問題的動機,研究問題的敘述,解決此問題的方法,以及研究具體成果的簡略描述。

4.     簡介與文獻回顧的寫法

在技術報告中,「簡介」有三個重要功能:(1)建立研究問題的整體動機,(2)敘述所要研究的目的,(3)敘述本技術報告的架構。下面一段文字便是在建立“高齡化社會問題”研究的動機:

“聯合國「世界衛生組織(World Health Organization, WHO)」將65歲以上人口佔其總人口比例在7%以上的國家,定義為「高齡化社會(aging society)」。根據行政院主計處的統計資料顯示,隨著教育水準的提高與國人傳統觀念之改變,臺灣地區人口生育率逐漸下降,加上衛生醫療的進步與平均壽命之延長等因素,已在民國829月正式邁入高齡化社會【行政院主計處,民國83年】,目前65歲以上人口已經突破兩百萬人。人口結構的高齡化,在全世界都是普遍的問題,WHO1997年預測2020年時世界65歲以上人口,除了西亞、非洲、中美洲65歲以上人口比例還在5%以下之外,大部分國家和地區都在10%~20%,部份西歐、北歐國家和日本,預測65歲以上人口比例更將超過20%[World Health Organization, 1997],高齡化的問題十分嚴重。”

上段文字中也可注意其中英文交替之寫法,以及中文、英文參考資料的寫法。研究動機建立後,「簡介」中的結論經常是一個“mission statement”,概括性地描述所要研究的目的。例如

“本計畫目的為設計一辦公與居家環境下使用,兼具健康、休閒、與生活輔助的多功能座椅。”

“本計畫目的即在針對機械系大學部三年級同學,製作一套機電整合設計基礎課程動態數位教材,適合大學部機械設計課程使用。”

在建立研究的動機、凸顯此研究問題的重要性時,常需引用文獻、數據客觀地支持作者的論點。在技術報告中文獻的引用有許多功能,除了建立研究的整體動機、凸顯此問題的重要性之外,文獻回顧也可對此領域的研究分門別類作一整體瞭解,除了避免重複別人已經做過的研究工作外,更可以具體指出哪些部分研究還沒有作,或是目前作得不夠完整,有繼續研究的必要。另外在敘述研究方法時,也常需引用研究文獻中既有的方法或數據,或使用文獻中的例子重複執行,與之比對,證實本研究之效果。

許多技術報告或論文,常以單一章節來作文獻回顧,甚至許多文獻回顧只是流水帳式的敘述,並沒有清晰地表達文獻回顧的結論。在技術報告中,文獻回顧應依據其所要達成的功能作不同安排,分散在各章節中。

參考文獻的目的是用來佐證作者的論點,參考文獻的選擇自然也應注意其公信力,例如應選擇引用比較知名的作者、或比較有權威性或公信力的資料出處,像是網路張貼的文章、上課講義、甚至報紙或雜誌報導,便不是適當的參考資料。

參考資料在內文中的寫法各個刊物規定不同,有依照引用順序使用編號的方式,如“[1, 2]”,或依“作者-年代”方式,如“[Hsu, et al., 1999]”,或“【徐業良,民89】”。如無特別規定比較建議使用“作者-年代”方式,因為參考資料出自哪位作者、哪一個年份,也是有用的資訊。報告內文中如依“作者-年代”方式標示參考資料,報告最後條列所有參考資料時依照首位作者姓氏字母(英文)或筆畫(中文)排列,中英文資料分開,先英文後中文,如下例:

Reference

Bannantine, J.A., Comer, J.J., and Handrock, J.L., 1990. Fundamentals of Metal Fatigue Analysis, Prentice-Hall, Inc.

Hopfield, J.J., and Tank, D.W., 1985. “Neural Computation of Decisions in Optimization Problems,” Biological Cybernetics, v 52, p 141-152.

5.     研究方法與結果的寫法

研究方法與結果的敘述是技術論文的主體,寫作上一定要要求嚴謹,但也要顧及可讀性。工程技術報告敘述相關原理時,常需要以數學式推演,例如

                                                                                                       (1)

where F is the force, m is the mass, and a is the acceleration. Note that the single characters “F”, “m”, and “a” are in italic.

所有數學式子應標示編號,後續提到時便可直接以“式(1)”來稱呼。敘述相關原理時所提到的變數或物理量,應以符號適當予以命名並在方程式後說明,且在整篇技術報告中都能保持一致。

在敘述研究方法與結果時也常用圖形來說明流程。每一個圖形都必須要在內文中被提及並說明,圖形在內文中被提到後,隨即跟著該段文字後出現,包括圖形、圖號、及說明。技術報告中圖形的繪製需要很深入的思考,每一個圖的存在,都應該有其必要性,圖形中的線條、形狀也都要有其意義。如圖1是「鼾聲監測裝置之感測流程」,這個圖有以下幾項缺點:

(1)   圖形中只描述了四項序列執行的項目,用簡單文字即可說明,不需使用圖形。

(2)   圖形中每一項目均用方格表示,然而意義卻完全不同,例如“聲波訊號”是鼾聲監測裝置要接收外界訊號,“濾波器”和“智慧型判斷程式”是鼾聲監測裝置中的軟硬體,“即時顯示”卻又是鼾聲監測裝置執行的功能。

(3)   圖中箭頭代表的意義也不清楚,是代表訊號的傳輸還是工作項目的順序?

1. 鼾聲監測裝置之感測流程

2是“Telepresence Gazer系統概要圖”,這個圖就有足夠的複雜性,需要以圖形表示,方格中均為硬體元件,箭頭以不同顏色表達元件之間的訊號、電力、與力的傳遞。圖3是工程教育計畫整體流程圖,圖形的繪製的過程也代表了對研究方法的架構深入而完整的構思,畫好這樣的流程圖之後,研究方法的表達就只是“看圖說話”了。

2. Telepresence Gazer系統概要圖

5. 工程教育整體計畫進行流程