問題
新人接手項目時,最怕的就是啥說明都沒有,只有代碼的項目,運氣好的還有人短期指導你一陣,運氣差的怕是上來就接手一堆代碼,組裏也沒有人熟悉,這個時候就只能看代碼
觀點
- 寫文檔就是浪費時間
- 沒有文檔就是瞎搞
究竟要不要寫文檔呢?相信各位覺得文檔還是必要的,儘管寫文檔確實很花時間
哪些文檔
文檔也不是越多越好,文檔是爲了讓開發更快地熟悉項目,但過多的文檔,則看不到重點了。結合本人經歷的項目列舉以下必要的文檔:
- 思維導圖
- 時序圖
- 業務流程圖
- 接口文檔
- 架構圖
做產品的同學可能還要寫***PRD文檔***,這個東西目前沒有統一標準
所有的文檔需要統一維護,一旦接口變動要及時更新
對於複雜的操作流程,都要說明文檔,避免負責這個模塊的人一走,其他人都不搞不清楚,動一下就出大問題
個人感悟:寫完這些文檔後發現自己對項目各模塊和功能都很熟悉,因爲寫文檔的同時把實現邏輯都想了一遍,寫代碼自然沒那麼困難