拒绝形式化的软件工程文档_项目管理文章库

用户名密码

联盟服务关于我们联系方式收藏本站

PgMP认证，美国项目管理协会高端项目管理认证！大型项目与项目群管理Program Management全球权威认证

服
务
区

网站登录：会员企业专家服务商
企业服务：PMP培训内训课公开课
工具箱：发表文章提问题发案例

首页：动态 | 文库 | 下载 | 书架 | 访谈 | 专栏 | 专题 | 人才 | 培训 | 软件 | PMC

互动：活动 | 案例 | 问答 | 论坛 | 博客 | 圈子

应用：基础┊工程┊软件┊制造┊活动┊研发认证：PMP┊NPDP┊ACP┊PgMP┊IPMP┊P2┊ISPMP┊IMCP┊建造师┊MPM 特色：热点┊奖项

适合敏捷开发项目
敏捷项目管理最佳实践

重视项目商业分析
商业价值与需求分析能力

产品管理国际认证
全球产品管理最佳实践

单项目管理经典指南
年轻项目经理首选

北京 | 直播 | 录播

大型复杂项目全球标准
定位高级项目管理层

链接战略与项目
实现组织资源投资回报

信息系统项目管理师
系统集成项目管理工程师

计划 | 报名 | 经验

当前位置：文库首页 >> 文章内容

拒绝形式化的软件工程文档

作者：byronm 提交人：项目管理者联盟[byronm] 属性：提交人转载发布时间：2009/2/24 点击：8317 【收藏本文】

　　最近在一个软件公司实习，这是一个小型的公司，承接政府和事业单位的一些工程项目。项目经理博客

　　我在这个企业所遇到的所有事情相信在中国绝大多数地方和绝大多数软件企业中尤为重要。项目管理者联盟
项目管理论坛
　　我已经在很多次的公开场合批评过形式化的软件工程，就是将书本上所要求的软件工程实践内容不经过任何具体化的措施和方法直接形式化套用。项目管理者联盟
项目管理者联盟
　　这个做法的后果是极大的浪费了时间和资源，打击了开发者的积极性。项目经理博客
转自项目管理者联盟
　　文档的本质是什么？为什么要写文档？什么样的文档才是有用的文档。项目管理者联盟
项目管理者联盟
　　大多数的程序员没有主动写文档的习惯，这个可以接受，因为并不是所有的文档都有用，大概九成以上的文档是实际上的多余。大家应该仔细考虑文档所处的位置和作用。项目管理者联盟
service.mypm.net
　　——为什么不剪裁？项目管理者联盟
项目管理者联盟
　　——因为我们不知道哪些信息是有用的信息，所以没有办法建立“有用”的文档。项目管理者联盟
项目管理者联盟
　　在开发工具和开发模式高度发达的今天，我们还在用“手工作坊”的方式写着文档。项目管理者联盟
项目管理者联盟
　　我们的开发是进步了，可是我们的文档化却没有进步。项目管理者联盟
项目管理者联盟
　　我对软件工程一直秉持着实用化的态度。这个和RUP的原则也颇为类似。项目经理圈子
项目管理者联盟
　　作为一种可以剪裁的软件过程方案，RUP在实际的应用上已经远远做到了我们现在还没有做到的境界。项目管理者联盟
项目管理者联盟
　　从需求、设计、实现、编码、测试的一系列过程。我们需要的是“准确记录”，而不是文字堆砌的卷宗。 bbs.mypm.net
项目经理博客
　　文档的本质就是“记录”，而记录的方法却有多种多样，“我们没必要用文字成篇的去描述，而一两个图形或者图像更有表现力”，UML如是说。项目管理者联盟
项目管理者联盟
　　而我在前篇文章所说的带着一部DV去做需求，还是因为在需求的过程中需要采集需求，进而就需要记录。而文字的表达能力是有限的，你不可能把一部人性化的软件交给一叠冷冰冰的纸张。因此，我们需要广泛的采集需求的信息。这时我们是在同客户分享一种感觉，一种用软件的感觉。 service.mypm.net
项目管理者联盟
　　说到需求的分析，用例图给了一种改进，但不是里程碑式的改进。微软的开发过程就充分的体会到这样的问题，所以提出了一些改进的措施，可能是因为微软所做的软件并不是管理系统的原因吧。 club.mypm.net
项目管理者联盟
　　到了设计和开发，作为结构最主要的表达——图形发挥了很大的作用，目前为止应该是最丰富的表达方法。项目管理者联盟
项目管理者联盟
　　然而我们却乱画一气……不根据变更的需求去变更设计……设计文档又成了一种形式。我在很多地方都看不到设计文档，因为这个依靠想象力和创造力的领域变化的太快，文档跟不上思维。而我们需要的是一种可以经过反复讨论的设计思路，我们需要统一的设计规范——设计模式。它告诉我们在什么样的情况下需要什么样的设计。而Gof-23模式甚至不够用，他们只是遵循了某种面向对象的原则。但是AOP是否有这样的模式呢，据我了解，是有的，只是很少有人总结。我希望很多专心于AOP的人可以像专心于OOP的那样总结出一些设计模式。 club.mypm.net
项目管理者联盟
　　编码阶段的文档——这可能是大多数软件工程实践中最成篇累牍但是最没有用的文档了。项目管理者联盟
项目管理者联盟
　　我所提倡的是良好的设计，良好的设计可以让编程人员（无论是专业还是非专业）对于实现可以做到一目了然。类似于一种模式，例如某个地方需要冒泡排序，我们就知道代码如何实现的。而不用考虑它是怎么实现的。设计文档就要做到这一步，能够很轻松的告诉编码者整个框架是什么，整个结构是什么，而到了具体实现需要怎么做。而到了这一步，我们所需要的文档可能很少，甚至——没有。项目管理者联盟
项目管理者联盟文章
　　编码阶段一直提倡的是自文档化的代码。这样的代码不光极具可读性，而且极具格式和规范性。我们所需要的可能仅仅是一份编码规范。剩下的，交给注释吧。项目管理者联盟
项目管理者联盟
　　或者可以说：文档即是代码，代码即是文档。 PgMp.mypm.net
项目管理者联盟
　　这是编码文档的理想境界。但是这是需要很好设计才能做到的。而这样的设计是需要长期编码-设计，设计-编码训练才可以达到的境界。项目管理者联盟
service.mypm.net
　　而代码规范，便是这个阶段最重要的因素了。好的代码规范会早就高可读性的代码——这是我们不需要在编码阶段另写文档的重要原因。因为这样不光可以节省了时间和资源，还提高了代码的质量。项目管理者联盟
项目经理圈子
　　关于测试阶段的文档，这应该是及其重要的一环。如果是使用的RUP的软件过程，和现在通常使用的螺旋模型的话，当然类似的模型可以。这类软件要求测试对需求能够有一个反馈，这是大家常用的模型的特点。项目经理圈子
项目管理论坛

[相关文章]

[网友互动]

·敏捷等于没有文档吗？ (1733)	项目管理者联盟	10-27
·软件项目文档管理中折射出的管理. (3370)	乔东	10-10
·项目管理文档之六：团队与流程 (2114)	马琛	03-22
·项目管理文档之五：存储与复用 (2167)	马琛	03-20
·项目管理文档之四：文档渠道与传. (2043)	马琛	03-07
·项目管理文档之三：文档定义 (3294)	马琛	03-01
·项目管理文档之二：问题 (3706)	马琛	02-24
·项目管理文档之一：综述 (4129)	马琛	02-21

01-12[帖子] 如何高效进行项目文档的编制及管理？ (5369)
10-10[帖子] 《软件项目文档管理中折射出的管理理念. (2929)
09-13[帖子] FTP在项目文档管理中的应用 (1308)
07-28[帖子] 用这3个简单的方法，来降低项目中的文档 (5219)
12-22[帖子] 如何理解项目文档生命期 (1361)
12-22[日志] 如何理解项目文档生命期 (946)
08-18[帖子] 敏捷开发中进度与文档的平衡 (8601)
08-18[帖子] 敏捷开发中进度与文档的平衡 (3839)

[发表评论]

本站热点

栏目说明

《文库》栏目为项目管理者联盟网站核心栏目，收录了十大行业项目管理文章5000余篇，囊括了项目管理五个阶段、九个知识领域的相关文章，是广大项目管理爱好者学习的知识库，欢迎大家发表原创文章、转贴文章，或直接发给编辑。须联盟会员且登陆后才能发表文章。

项目管理活动

活动QQ群：531390275
免费积累PDU,仅500人
2022年项目管理活动计划
2021活动精彩回顾

原创排行榜

项目管理评论杂志	311	高扬	106
乔东	100	项目管理	84
高国伟	61	人月神话	60
张为	59	郭致星	52
蒋昕炜	46	肖杨	38
曾伟强	37	潘德有	36

搜索文章

关键词：

行业：

团队成本风险进度
沟通采购质量合同

更多>> 专题集锦

企业项目化管理

PMO实践与应用

如何处理项目客户关系

经理访谈

个人专栏

王树文

赵春明

高国伟

项目管理者联盟特刊

	联盟特刊是对网站会员发行的内部刊物，刊物内容包括：案例及分析等，得到了会员好评。
电子期刊：
特刊下载：
2017合刊 2016合刊 2015合刊 2014合刊 2010合刊 2009合刊 2008合刊 2004合刊 2005合刊 2006合刊 2007合刊

施工企业管理

	《施工企业管理》创刊于1986年1月，中国施工企业管理协会主办，是反映施工企业管理杂志。
浏览往期：

建造师杂志

	《建造师》杂志由清华国际工程项目管理研究院主办，是中国面向建设企业管理人的高端杂志。
浏览往期：

如转载本站文章，必须于文章开头处注明转自“项目管理者联盟”，并注明原作者

PMI,Project Management Professional, OPM3, PMBOK, PMP，PgMP，PfMP，PMI-ACP，PMI-PBA
and the PMI Registered Education Provider logo are registered trademarks of the Project Management Institute, Inc.