寫程序，做產品，過日子

成功其實很簡單，就是強迫自己堅持下去

BlogJava

管理

69 Posts :: 1 Stories :: 92 Comments :: 0 Trackbacks

郁悶，高級開發員居然不喜歡寫文檔

今天安排幾位高級開發員更新產品的設計文檔。要求一要和代碼完全一致，二要具體到類和公用方法。

不料有幾位對兩個要求都不理解，認為沒有必要。

我解釋說：咱們做的產品，幾十號人，做了五六年的產品。如果不寫好文檔，別人就沒法順利的接手，到時候什么事情都得問你，這樣對你的發展很不利。

有同事聽了我這話更是漠然的說：“別老是和發展扯在一起。”

唉，真不知道該怎樣激勵他們。對自己的職業發展都漠然視之。別跟我說是老板不給機會。

posted on 2006-12-11 20:39 Welkin Hu 閱讀(863) 評論(4) 編輯收藏所屬分類: 技術管理

Feedback

# re: 郁悶，高級開發員居然不喜歡寫文檔 2006-12-12 10:18 weidy

看上去你是個新上來的領導吧，不是我批評你，“完全一致、具體到類和公用方法”的要求十分的蠻橫和武斷，證明你沒有真正理解項目組織的實質，沒有理解文檔是做什么的，應當在項目中承擔什么樣的作用。
你被抵制是情理中的，一方面你這樣的要求過于理想化很難真正達到目標，另一方面也是揚短逼長，對人力物力資源的浪費，文檔的維護性和表達能力遠不如代碼，代碼里一個通用約定，幾十個字母能說清楚的問題用文字去表述要寫多少字（還不考慮有些程序員對寫文檔有天生的厭惡）？就算你說的要從面向未來的角度，那你將來要同步文檔和代碼，又需要多少的投入, 有多少實際的可能？算了，這個問題也不多說了，等你多碰幾次壁，自然就領會了。

回復更多評論

# re: 郁悶，高級開發員居然不喜歡寫文檔 2006-12-12 19:48 Welkin Hu

不敢茍同Weidy的意見，看了一下你的blog，比較推崇XP。我也很向往XP。可惜的是我的的產品規范是RUP。條條大路通羅馬，XP雖好，卻不一定適合每一個人。
的確有很多程序員喜歡寫代碼，討厭寫文檔。但如果是一名高級開發員，他的主要職責就是分析和設計。一個設計者如果不能把文檔寫好，怎么能成其為設計者？我們公司有一個目標就是，高級開發員不寫代碼，只寫文檔。
關于文檔的維護性和表達能力遠不如代碼這一點也值得商討。代碼是純文字，文檔的主要內容是圖表，哪個更清楚顯而易見。
Weidy提到文檔將來要同步文檔和代碼的投入問題，這個投入對于一個項目來說的確不堪承擔，但對于一個產品來說，必做不可。
這一次根據安排，我們要投入15個人天來做這個事情。

回復更多評論

# re: 郁悶，高級開發員居然不喜歡寫文檔 2006-12-28 09:33 奇葛格

對 “文檔” 這兩個字可能有不同的理解。
我個人傾向于“代碼注釋(javadoc)+UML圖表+清晰的架構說明圖表”。
Word文檔是商務人員使用的表達方式，承擔不起程序世界的思想交流。

解決問題的方法之一是統籌規范，化繁為簡。
如果你的項目依賴于過多的細節實現，可能是個不太優美的系統，你不得不關注細節的方法實現。

當然，如果是要參加競標，提高系統價值，另當別論。回復更多評論

# re: 郁悶，高級開發員居然不喜歡寫文檔 2007-03-27 14:07 BeanSoft

同感, JavaDoc 和基礎的流程, 數據庫文檔, 必須得有. 至少 JavaDoc 是可以同步產生的, 隨時更新的. 看看 JDK 的 JavaDoc(當然實際開發不用這么細) 就明白為啥 JDK 的編碼規范被人推崇. 回復更多評論

新用戶注冊刷新評論列表


只有注冊用戶登錄后才能發表評論。




網站導航: 博客園 IT新聞 Chat2DB C++博客博問管理
相關文章: Project Management Programs Probation 郁悶，高級開發員居然不喜歡寫文檔 Plan to use track+ in my project

寫程序，做產品，過日子

常用鏈接

留言簿(14)

隨筆分類(64)

隨筆檔案(69)

相冊

搜索

積分與排名

最新評論

閱讀排行榜

評論排行榜

Feedback

寫程序，做產品，過日子

常用鏈接

留言簿(14)

隨筆分類(64)

隨筆檔案(69)

相冊

搜索

積分與排名

最新評論

閱讀排行榜

評論排行榜

Feedback

寫程序，做產品，過日子