[[320955]]

后記：相信很多程序員都深有體會，寫文檔真是一件痛苦的事情，正如文章中所說，需求會變，文檔如果不跟著變就會過時(shí)，過時(shí)的文檔甚至?xí)a(chǎn)生誤導(dǎo)的作用?？墒悄貙懳臋n又是一件不能給自己立刻帶來什么價(jià)值的事情，累死累活把代碼寫完，把bug改完，下一個(gè)任務(wù)就在那里壓著，還要求寫文檔，這就太要命了吧!所以大家都不愿意寫文檔，于是就造成了一種怪圈：大家看代碼的時(shí)候都希望有文檔輔助， 但是又沒人寫文檔。

我覺得一個(gè)項(xiàng)目的文檔沒有必要寫得面面俱到，事無巨細(xì)，那樣確實(shí)費(fèi)時(shí)費(fèi)力，但是有幾類文檔是必不可少的。首先是需求文檔，一般是Use Case的方式，主要描述需求，里邊有角色和業(yè)務(wù)流程，正常分支和異常分支，讓新人一看就知道這個(gè)系統(tǒng)是做什么的。其次是架構(gòu)文檔，主要描述系統(tǒng)有哪些技術(shù)組件構(gòu)成，他們之間是怎么交互的。第三類視項(xiàng)目而定，主要是對于關(guān)鍵模塊的描述。

【本文為51CTO專欄作者“劉欣”的原創(chuàng)稿件，轉(zhuǎn)載請通過作者微信公眾號coderising獲取授權(quán)】

戳這里，看該作者更多好文