不會寫文檔的工程師不是好程序員

自一年多沒作技術以來，遇到一些技術同事離職或者參與平臺的架構技術評審，每次都感受困難，文檔是其中一個重要緣由，要麼是隨意寫一份交接文檔完事，要麼就是簡單畫幾副邏輯圖來說解評審，更多的是靠口訴。要說咱們團隊的這些技術人員個頂個也都算公司中的「高手」，可是我卻以爲他們還欠缺一個真正的高手所須要的「必定要讓別人清晰的、簡單的理解你作的，所說的」。另外咱們是如何瞭解歷史的，我想就是由於不少人寫下了歷史，咱們的程序不就是一部歷史嗎？

---

固然這篇文章的標題一寫出來，估計有不少程序員朋友就要準備噴我了，說「咱們高手都是用代碼說話」，說「你看王二就是巴結領導寫得一手漂亮文檔就順利升遷，技術和shi同樣」，說「教條化外包管理才重視文檔，俺們崇尚敏捷、極限的開發不重視文檔」......我記得咱程序員這個羣體有不少標籤「木訥、不善言談、甚至生活邋遢......」，可是歷來沒有「不善於寫」這點，正是因爲」善於寫「程序員們纔有了」不善言談」的補充，纔有了「悶騷」這個標籤。

我以爲一份好的技術文檔應該.....光說不練你們確定鄙視我，見兩年多前我寫的兩份技術文檔吧。好很差另說，至少態度