[心得] 怎麼寫技術文件

先說明，這篇文章只是為了給伙伴看的，它不是一篇正規的文件寫作技巧；因為我也沒學過類似的東西，只是把自己的經驗與心得整理出來分享給大家。

擬定大綱

在寫文件或投影片之前，先把大綱擬定出來是很重要的。寫一篇文章就好像開車上路，有起點也有終點；而且你一定要先確認哪裡是可以走的，把大方向先找出來。大綱的主要目的就是讓我們自己確認文件大致要描述的東西，不致讓我們整個走偏掉。

大綱要怎麼寫呢？首先先把大標題寫下來，確定整篇文件的方向。然後你可以繼續在每個大標題下再補上小標題，將整篇文章的輪廓描繪清楚。

條列說明

擬定好大綱後，我們可以開始寫文章了。不過大多數人都不容易一下子寫出洋洋灑灑、圖文並茂的內容。這時我會建議大家採用條列式說明法，先將重點條列成骨架，再慢慢為它們添血加肉。

條列式說明主要可以簡短扼要先將重點記下來，寫文章的人也不會因為要想落落長的詞句而忘了其他部份的重點。列好重點後，你再用你精美的修辭與曼妙的詞句去補充它們，但切記不要讓文句流於枯燥與繁瑣。

正確地引用與摘要

技術文件很重要的一點就是正確性，所以有時候你可能會需要在你的文章裡補充某些技術性的觀念；這時你可以直接引用別人寫過的文章，把重點摘要在段落之間。最重要的是讓看的人不用點選連結就能簡單掌握住這個觀念，需要詳細瞭解時再點選連結即可。

適時加上圖片或範例

有時候寫了一堆不知所云的說明還講不清楚時，你倒不如用張圖來解釋你的想法。不過有時圖片也不容易解釋清楚，這時你還可以直接用範例說明。

畫圖或範例主要的目的是讓看的人自己在腦海裡產生說明，但簡單的文字敘述還是必要的，免得畫者無心，看者有意。

將它讀出來

很多人寫文章都是寫完就算了，自己根本沒有回頭再多看幾次；所以糟糕的排版，錯誤的標點符號，完全不通順的句子，常常會出現在這些人的文件裡面。

要解決這個問題，我建議你自己讀一次你自己的文章；最好能大聲唸出來，然後把它錄下來播給自己聽，沒睡著就算成功一半了。

說服自己

沒有什麼項目是比說服自己更重要的了，如果你自己寫的東西都無法說服你自己，那又怎麼能期待別人看得懂呢？

不過說服自己並不是催眠自己對自己的文件有莫明奇妙的信心，最好能用完全忘掉內容的心情去重看一次；如果越讀越覺得自己對這份文件的內容掌握度很夠，那這樣一來你的寫作能力就能更往前邁向一大步。

用部落格來練習

很神奇的是，我在寫部落格會有一種我是寫給別人看的感覺 (其實不一定會有) ；所以我自己在寫部落格文章時，就會對自己寫的東西有一種莫明奇妙的責任感。當然不一定每個人都是這樣，但這的確不失為一種好的自我訓練方式。如果有人指正你寫錯了也沒關係，因為這就是我們練習的目的。

總之，寫技術文件其實並沒有想像中那麼困難 (但會覺得麻煩是很正常的) ，重要的是你有沒有重視它，多寫多練習吧~