???

??? 一提到寫文檔，可能很多程序員可能會不屑一顧，但是，無論處于規范開發流程，還是就于逃避嫌責的目的，能夠將自己所從事的工作用文檔描述記錄下來，還是一件很有成就感的事情，拋開其功用不談，就個人的成長進程看，也是一個循序漸進式的好習慣，還是值得大家稍微關注一下的。

??? 昨天在和同事的一次交流過程中，就自己編寫的講演文檔得到大家的一些有益反饋，不敢獨享，曬出來和大家一起分享：首先，要明確文檔的應用人群和該人群對其內容的偏好程度，因為人越多，需求點可能就會越多，而我們往往會采取一條主觀內容路線的方式進行串接、講解，這樣的邏輯順延效果主要發生在我們自身，而對于聽眾來說，可能就很難達到進一步的共鳴了，但，這一點往往不被我們察覺，自我感覺思路清晰，侃侃而談，就認為自己交流的夠清晰，其實不然，聽眾對該內容不出意外都會較我們少很多，就我們記錄的文檔內容，可能很難將這些內容進行串接，進而形成一個清晰的概念，于是降低了交流效果，加上大家又比較晦澀，可能不會就過多的內容進行異議，于是……

??? 如何才能有所改進呢？

（1）在編寫文檔前，就目標群體進行一下簡短的需求調研
（2）將文檔的理解點盡量降低，由淺入深地進行介紹，并盡量將一些要點醒目標出，方便溫習和查找
（3）文檔中盡量使用圖釋來記錄信息，文字內容要少而精，但是切忌圖釋為取彩而忘本，華麗并不能代替標準的信息傳達
（4）根據文檔進行講解的時候，最好能夠同時使用實時系統進行輔助，要擅于使用好投影儀等講解工具
（5）注意大家的意見反饋，就講解過程中出現的一些不能馬上回答的問題，要在交流后第一時間反饋給大家

?

總結

以上是生活随笔為你收集整理的小议程序员编写技术文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。