Just enough(刚刚好)的软件开发文档什么样?

本文探讨了在敏捷开发环境下,如何创建既不冗余又足够的软件开发文档。强调了文档应该注重实用性,服务于团队沟通和测试,而非成为负担。通过实例展示了如何在迭代过程中动态更新文档,确保其始终保持最新状态。
摘要由CSDN通过智能技术生成
 

在今年与多个软件开发单位的交流中,补文档的问题多次提到,试图通过本文谈谈文档的价值,如何写刚刚好的文档。

软件开发所需要的文档在传统的瀑布型生命周期下典型的有:开发计划,需求规格说明书,设计书(有分成基本设计书、详细设计书;也有分成High Level Design、Low Level Design;或者概要设计、详细设计), 测试计划(测试用例),测试报告,结题报告。其中的需求规格说明书和设计书是过程中最重要的两份文档,往往多达数十页,甚至数百页。 后期,文档与实际软件的一致性问题是比较突出的,往往出现软件已经修改,而文档还没有修改,两者不一致。

 

敏捷开发针对这种情况提出了“可用的软件 重于 完备的文档”,提出文档要Just enough。

那么到底如何Just enough? Just enough的对比是什么呢?

 

大而化之,可以将文档的“Just enough”归纳到三种不同的极端需要:

1,通过文档,只要让明天加入这个团队的新人了解所要知道的内容就行了,不在文档中的内容,团队老成员会通过诸如结对、协作等等方式告诉新人;

2,通过文档,可以处理当前项目结束后的维护,或者是后续跟进项目。

管理层和敏捷团队自身可以考察团队的稳定性,项目所处阶段来判断需要什么样的文档。如果团队成员离职率高,文档需要就大,如果项目处于晚期阶段&#

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值