???

??? 一提到寫(xiě)文檔，可能很多程序員可能會(huì)不屑一顧，但是，無(wú)論處于規(guī)范開(kāi)發(fā)流程，還是就于逃避嫌責(zé)的目的，能夠?qū)⒆约核鶑氖碌墓ぷ饔梦臋n描述記錄下來(lái)，還是一件很有成就感的事情，拋開(kāi)其功用不談，就個(gè)人的成長(zhǎng)進(jìn)程看，也是一個(gè)循序漸進(jìn)式的好習(xí)慣，還是值得大家稍微關(guān)注一下的。

??? 昨天在和同事的一次交流過(guò)程中，就自己編寫(xiě)的講演文檔得到大家的一些有益反饋，不敢獨(dú)享，曬出來(lái)和大家一起分享：首先，要明確文檔的應(yīng)用人群和該人群對(duì)其內(nèi)容的偏好程度，因?yàn)槿嗽蕉?#xff0c;需求點(diǎn)可能就會(huì)越多，而我們往往會(huì)采取一條主觀內(nèi)容路線的方式進(jìn)行串接、講解，這樣的邏輯順延效果主要發(fā)生在我們自身，而對(duì)于聽(tīng)眾來(lái)說(shuō)，可能就很難達(dá)到進(jìn)一步的共鳴了，但，這一點(diǎn)往往不被我們察覺(jué)，自我感覺(jué)思路清晰，侃侃而談，就認(rèn)為自己交流的夠清晰，其實(shí)不然，聽(tīng)眾對(duì)該內(nèi)容不出意外都會(huì)較我們少很多，就我們記錄的文檔內(nèi)容，可能很難將這些內(nèi)容進(jìn)行串接，進(jìn)而形成一個(gè)清晰的概念，于是降低了交流效果，加上大家又比較晦澀，可能不會(huì)就過(guò)多的內(nèi)容進(jìn)行異議，于是……

??? 如何才能有所改進(jìn)呢？

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

?

總結(jié)

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

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。