技術寫作的要素

1. By Technical Communication Ltd
www.technicalcom.co.il
技術寫作訣竅 Technical Writing Tips

2. 恭喜您進入了技術寫作的行業。
您也許是科技公司專職的技術寫作人員，
首先，
或是自由工作者。
都可以在此學習到一些基本的寫作訣竅，讓您的作品
井然有序
而且
有效率

3. 技術寫作的範圍
使用說明書
教育軟件及訓練
產品規格
線上支援
編輯報告 計畫書 電子書 翻譯

4. 了解你的讀者
第一，先確認文件的讀者身份，以及他們如何使用你的文件。
文件的目的為何？文件的功用？文件的使用地點在哪？例如，是在
辦公桌前，工廠操作台前，或是實驗室內？
以上皆是最基本的考量，也決定了文件的寫作方式。當您開始計畫
整個文件寫作及編排設計時，皆要考慮到讀者的實際需求。
訣竅 1 – 了解你的讀者

5. 完善的準備
在編纂你的文件前，先熟悉相關的文件主題，再開始對企業及相關人士
進行訪談。
大量蒐集有關此系統或設備的資料，這對往後的工作將省很多時間。
將這些背景資料分類，可依照重要性排序。對於訪談對象，提出對的問
題，而且也必須用文件讀者的角度來設想。
訣竅 2 – 完善的準備

6. 同工合作
找出負責文件圖示繪畫的人員，截取螢幕畫面。
如果你同時也是繪圖製作者，則要考慮到相關使用工
具。
準備大綱
先提列文件的大綱，並提交企業及關係人士的
確認。當大綱內容被批准後，你就可預估整個
工作的範圍及時序。
訣竅 3 – 同工合作
訣竅 4 – 準備大綱

7. 訪談
根據大綱的內容範圍，對企業
以及有關人士進行訪談。
組織文件
使用「具體任務」的處理方式，設計整個文件
的架構。
例如，「安裝說明 」應該放在文件的開頭章
節。
訣竅 5 – 訪談
訣竅 6 – 組織文件

8. 範本的風格
注意文件的整體視覺效果。在一開始就建立相同風格
的範本，或是使用現成範本。如果在文件的編纂中才
變換風格，將非常耗時。
當設計範本時，也要容許有可能轉換範本的彈性，以
便真的需要變更時，不會太耗時耗力。
訣竅 7 – 範本的風格

9. 加入圖示
圖示是文件手冊整體的一部分。
利用圖說輔助文字，表達更清楚，但不要過度使
用。
圖像及文字的交互使用，讓內容簡單明瞭。
訣竅 8 – 加入圖示

10. 簡明易懂
使用主動式、現在簡單式的文法。避免高深的術語。
你的讀者不想耗費時間及精神查閱字典。
利用 【七秒法則】為歸依 －任何資訊必須讓讀者在七
秒鐘內找到。如果超過七秒，大部分使用者會放棄搜尋。
詞彙表
建立詞彙表索引，幫助你的文件用字統
一，也讓讀者方便查詢手冊中的詞彙。
訣竅 9 – 簡明易懂
訣竅 10 – 詞彙表

11. 審核
在發表文件前，聚集一個任務小組進行審核。
小組成員可以包括技術寫作人員，兩三位開發人員或是企業
內部人員，還有一位從未參與的非相關人員（例如，業
務）。
此審核小組必須得到最高階主管的支持。審核過程中，須取
得相關的設備儀器，以及工作平台。
訣竅 11 – 審核
納入在地化的考量。
這也是「了解你的讀者」中重要
的注意事項。

12. Good Luck!
希望這些訣竅能幫助你完成工作。
我們能幫忙的不只這些！
想知道更多嗎？連絡我們：
techcom@netvision.net
或是造訪我們的網站：
www.technicalcom.co.il