[[320955]]

后記：相信很多程序員都深有體會，寫文檔真是一件痛苦的事情，正如文章中所說，需求會變，文檔如果不跟著變就會過時，過時的文檔甚至會產生誤導的作用。可是呢寫文檔又是一件不能給自己立刻帶來什么價值的事情，累死累活把代碼寫完，把bug改完，下一個任務就在那里壓著，還要求寫文檔，這就太要命了吧!所以大家都不愿意寫文檔，于是就造成了一種怪圈：大家看代碼的時候都希望有文檔輔助， 但是又沒人寫文檔。

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

【本文為51CTO專欄作者“劉欣”的原創稿件，轉載請通過作者微信公眾號coderising獲取授權】

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