写程序，做产品，过日子

成功其实很简单，就是强迫自己坚持下去
BlogJava 首页 新随笔 联系 聚合 管理
  69 Posts :: 1 Stories :: 92 Comments :: 0 Trackbacks
郁闷，高级开发员居然不喜欢写文档

今天安排几位高级开发员更新产品的设计文档。要求一要和代码完全一致，二要具体到类和公用方法。

不料有几位对两个要求都不理解，认为没有必要。

我解释说：咱们做的产品，几十号人，做了五六年的产品。如果不写好文档，别人就没法顺利的接手，到时候什么事情都得问你，这样对你的发展很不利。

有同事听了我这话更是漠然的说：“别老是和发展扯在一起。”

唉，真不知道该怎样激励他们。对自己的职业发展都漠然视之。别跟我说是老板不给机会。

posted on 2006-12-11 20:39 Welkin Hu 阅读(855) 评论(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 的编码规范被人推崇.  回复  更多评论
  


只有注册用户登录后才能发表评论。
网站导航: