項目文檔的分類
項目文檔的分類
項目文檔的重要性
項目文檔的重要性
常見的誤區(qū)
- 寫文檔是浪費時間？沒時間寫文檔复局？
- 文檔本身也是產(chǎn)出：coding的時間少于30%
- 寫文檔是整理思路的過程：打字速度應(yīng)快于思考速度
- 沒有文檔，后期會花費更多的維護(hù)成本
- 這是個簡單的項目/問題，不需要文檔稳捆？
- 項目的延續(xù)時間和復(fù)雜性往往超出預(yù)期
- 早期的“偷懶”嗤无，往往在后期會付出代價
常見的問題
- 沒有接口文檔：多人協(xié)作出現(xiàn)問題
- 需求文檔沒寫好：
- 多次反復(fù)討論同樣的問題
- 沒有系統(tǒng)總體架構(gòu)文檔：
- 每個人都需要重新看代碼猴贰，還不一定能看清
- 缺少文檔
- 新人無從入手
- 人員變動時对雪，不好交接
- 團(tuán)隊內(nèi)溝通效率很低
- 自己過兩個月后，痛苦的回憶之前的思路
什么時候需要寫文檔米绕？
- 必須的文檔
- 需求設(shè)計文檔：需求瑟捣，重點，取舍過程
- 接口文檔：函數(shù)义郑，參數(shù)蝶柿，返回值
- 關(guān)鍵性的算法文檔：思路丈钙，關(guān)鍵點
- 系統(tǒng)總體框架：全局的思路
- 凡是不那么“顯而易見”的地方非驮，最好都留下文檔
- 不僅留下設(shè)計結(jié)果（what）,也留下思考 過程（why）
- 留下決策的依據(jù)，便于后面的工作
- 文檔不是寫完代碼后補(bǔ)出來的
- 文檔是設(shè)計過程中使用的工具雏赦、和設(shè)計過程的結(jié)果
文檔的書寫方法
- 拉提綱劫笙，自頂向下
- 大的標(biāo)題下，列出子問題
- 再對每個子問題逐步展開
-
反芻
- 感覺不好之后要及時修改
一句星岗，一段填大，甚至整個文章的結(jié)構(gòu) - 逐步提高自己寫文檔的能力
- 感覺不好之后要及時修改
- 讓重要的內(nèi)容醒目
- 標(biāo)題；段首第一句話
- 加重俏橘、有顏色允华、或者帶下劃線的文字
