蔡學鏞【言程序】部落格: 淺談技術寫作
淺談技術寫作
我在「超完美工作」一文中,提到「技術寫作」一詞,有資訊系的學生來信詢問如何進行技術寫作。收到此郵件,我覺得很高興!因為大多數的IT技術人員都不肯碰技術寫作,要他們寫程式沒問題,要他們寫技術文件簡直要他們的命。所以有人想主動學習技術寫作,難能可貴。
在國內,技術寫作一直是被忽略的主題,我認為,即使是在IT技術書籍作家中,具有技術寫作技巧者的比例還是不高。相反地,國外的IT大公司其實相當重視技術寫作,有時候會公布「Technical Writer」的職缺,這就是專職技術寫作的工作。
技術寫作的幾個基本要求是:
1. 很快學會新的技術
2. 能和技術人員溝通,主動挖掘技術重點
3. 具有流暢且精準的文字表達能力
除此之外,根據所寫的技術文件不同,技術寫作的方式也會有差異,例如:「技術白皮書」、「使用手冊」、「參考手冊」、「快速入門」、「自學手冊」…這些文件的寫作手法、範疇、與編排都是不同的。有些時候,技術寫作所生產的文件,不是最終文件,而是做為行銷等部門的素材,進行二次加工。
如果你有心學習技術寫作,我建議你去看相關的書。在http://www.amazon.com/上面搜尋「Technical Writing」,你可以找到許多本書。或許國內出版社應該引進一兩本翻譯成中文。
沒有留言:
不接受新意見。