最近正逢臺灣大學碩士班申請季。一位關係不錯的政治系學妹在申請臺大新聞研究所時，連第一階段的書面資料審查都未通過，於是把她的申請文件給我看。我簡單瀏覽過後，發現他犯了蠻多非常基本的錯誤 :p。但回頭想想，校內好像也沒有一門大學生的課程，專門教學生如何寫好一份專業的文件（倒是簡報課的信徒多到滿出來）。因此我也想趁這個機會，分享在孔令傑教授指導下，經歷一年半的專題研究與半年助教經驗所學到的幾項原則。

文件的靈魂是結構

一份文件要有好的結構，大概需要滿足以下兩個條件：

  • 文件前後段落的順序是合理的。
  • 文件不同段落的篇幅分配是合理的。

在開始寫一份專業的文件之前，我會做的第一件事情就是：計劃每個段落大概會描述什麼內容，並且確認每個段落的前後順序是符合因果關係的。以一篇理工科的學術論文為例，基本上都會有以下的結構：

  1. 標題
  2. 摘要：以簡要的文字描述整篇論文。
  3. 前言：描述這篇論文所要解決的某種問題。
  4. 文獻回顧：描述這種問題過去有什麼類似的解法？
  5. 實驗方法：描述我們計劃怎麼解決這種問題？
  6. 實驗結果：描述我們實際上解得好不好？
  7. 結論：在經過這個研究之後，我們有什麼結論？
  8. 引用資料
  9. 附錄

遵循如上各個段落的前後順序，我們就可以期待讀者一段一段讀完整份文件之後，可以用阻力最小的方式理解這篇學術論文所想要呈現的知識；反之如果在前言結束之後，作者就洋洋灑灑的開始把結論寫出來，省略推理的過程，那就很難說服讀者這個結論是正確、合理的。

在釐清各個段落的前後順序之後，我會做的第二件事情便是估計各個段落會佔用的篇幅是多少，越重要的段落應該要佔據越多的篇幅。這項原則鼓勵作者在最重要的段落，額外花費篇幅解釋某個議題/知識/觀點，同時避免作者在不重要的段落鑽牛角尖。以大型語言模型最為經典的學術論文 Attention Is All You Need 1 為例，該篇論文所提出的純注意力機制語言模型是整篇論文最有價值的地方，作者也額外花了很多功夫詳細解釋注意力機制有什麼特點、能解決什麼問題。實驗方法在本文中就分成了三個章節，分別為 Model Archetecture, Why Self-Attention 及 Training ，佔了整篇論文約一半的篇幅，但反之該篇論文嘗試解決的 Language Modeling 並不是太新穎的想法，所以前言只花了半頁左右簡單帶過。

一份文件有了良好的結構之後，下一步就是把各個段落的文字寫出來了。

文字是文件的主體

在撰寫文件時，要時刻記得文件和簡報不一樣，讀者在閱讀的時候作者本人是沒有辦法站在旁邊補充說明的，所以把文字寫得清楚、通順就格外重要。當然這方面更考驗作者的語言能力與經驗，但還是有一些原則可以遵循，以下舉例三點：

  • 文字要以最容易被理解的方式呈現。
  • 針對同一個東西，整份文件前後的用詞要保持一致。
  • 圖/表的作用是補充說明。

我認為第一點是最重要的。撰寫文件時，作者通常已經深入理解了這項議題，之後才會開始動筆，這就很容易造成作者與讀者之間的認知落差。作者有責任盡量縮小這種落差，確保內容是容易被理解的。以我的專題研究海報為例，其中某一段修改前的敘述為下：

本專案的主要目標是協助鋁門窗生產業者節省排程時間及最大化生產效率，透過建立模型與設計最佳化演算法，幫助規劃鋁門窗製造排程。其中，能夠滿足交貨時段以及不提前太早完成訂單尤為重要。能夠達成準時交貨，可以保留著客戶；而不過早完成訂單，則是讓產品不會太長時間堆積在廠內。

修改後的敘述為下：

本專案旨在使用作業研究方法建立數學模型與設計最佳化演算法，協助鋁門窗生產業者節省規劃生產排程的時間及最佳化生產效率。本專案將會計算準確的交貨時間，避免因延遲交貨而需要支付違約金，同時避免因提早交貨而衍生不必要的存貨成本。圖（一）為前往工廠參訪的照片，圖（二）為公司內部展間。

這段文字基本上想要描述這個專案的四個步驟：(1)公司有某種業務邏輯 -> (2)學生根據這個業務邏輯建立某種模型 -> (3)模型生出某種結果 -> (4)模型生成的結果對業務邏輯某種影響。由於我們小組已經執行這項專案整整一年，因此我們非常熟悉這四步驟的前後邏輯關係，進而導致在第一次撰寫的時候就漏掉了 “模型生出某種結果” 這一步，而需要讀者透過前後文自己腦補出來這個模型可以算出訂單的交貨時間。這導致這段文字在修改前很不好讀，修改完之後才算是合格的文字。

第二點我認為是文件和文學作品最大的不同,一份文件講求的是文字的精準度,而非華麗的詞藻。以資訊工程領域為例，同樣的 “X演算法” 也可以寫成 “X算法”、”X步驟”、”X處理機制”等，如果在同一份文件對於同一個東西混用不同的用詞，則有可能混淆讀者，因此在撰寫文章的過程中，一定要嚴格統一前後的用詞。

貓睡在藍色床單上的照片

圖（1）貓睡在藍色床單上的照片

第三點則體現了文件與簡報的差異。我們在求學期間多半接受較多簡報訓練，因此撰寫文件時常把簡報思維帶進來，遇到難以用文字描述之處就插入圖/表。視覺化確實有助於說明抽象概念，但關鍵是要以文字明確交代圖/表的用途與傳達的資訊。例如：如圖（1）所示，這隻貓睡在藍色床單上，很可愛。如此一來，圖/表才能發揮補充說明的作用，讀者也不會看到圖/表就一頭霧水。

魔鬼藏在細節裡

如果有確實遵守以上幾點的話，就能寫出一份不算太差的文件了，以下再補充一些我被教授叮嚀過的細節：

  1. 所有文件都要有頁碼。這應該是孔令傑教授最有名的堅持之一 XD。一份文件在很多時候是會被很多讀者同時一起閱讀的，這時候就會出現如 “在第 X 頁第 Y 行的…” 的口頭敘述，為文件加上頁碼可以幫助這些讀者快速找到特定的段落。
  2. 盡可能避免在圖表中使用黑白以外的顏色。由於我們無法確定文件抵達讀者手上的時候會是彩色的還是黑白的，因此製作圖表時要盡可能讓圖表在黑白印刷下也能被讀懂。以折線圖為例，紅色、綠色兩條線應該替換成實線、虛線兩條線。
  3. 中英文夾雜時注意標點與空格。資訊領域蠻常有中英文混用的情況。英文詞與後方中文名詞之間通常加半形空格，如 “Apple 公司”；但日期、數字與量詞結構如 “10月9日”、”3公斤”、”2025年” 則不需空格。整篇文件依個人習慣保持一致即可。
  4. 應區分數學式與敘述文字的格式。這點比較跟 LaTeX 寫作相關，原則上所有數學式或演算法符號都應置於 LaTeX 的 Math Mode 中，如： \(x+y\)；而勿以一般文字 x+y 代替。
  5. 要讀自己的文件。初稿完成後可以自己默讀檢查一次，通常會在過程中發現某些冗長或不清楚的句子，如此便可以即時修正。
  6. 字型、字體保持一致

雖然我們不可能把整份文件修改到完美，但是在細節上多花一點心思，就是最能展現作者專業程度的時候。

結語

任何專業文件都需要投入時間與心力反覆校訂。這個過程雖然漫長且瑣碎，但當你交出一份專業的文件時，讀者自然會把你的專業程度與文件的品質相連結。一篇好的文件能有效提升可信度，讓讀者更相信你的觀點與成果。我覺得在任何領域，這都是極具價值的！

引用

  1. Ashish Vaswani, Noam Shazeer, Niki Parmar, Jakob Uszkoreit, Llion Jones, Aidan N. Gomez, Łukasz Kaiser, and Illia Polosukhin. 2017. Attention is all you need. In Proceedings of the 31st International Conference on Neural Information Processing Systems (NIPS’17). Curran Associates Inc., Red Hook, NY, USA, 6000–6010. ↩