在今年与多个软件开发单位的交流中,补文档的问题多次提到,试图通过本文谈谈文档的价值,如何写刚刚好的文档。 软件开发所需要的文档在传统的瀑布型生命周期下典型的有:开发计划,需求规格说明书,设计书(有分成基本设计书、详细设计书;也有分成High Level Design、Low Level Design;或者概要设计、详细设计), 测试计划(测试用例),测试报告,结题报告。其中的需求规格说明书和设计书是过程中最重要的两份文档,往往多达数十页,甚至数百页。 后期,文档与实际软件的一致性问题是比较突出的,往往出现软件已经修改,而文档还没有修改,两者不一致。
敏捷开发针对这种情况提出了“可用的软件 重于 完备的文档”,提出文档要Just enough。 那么到底如何Just enough? Just enough的对比是什么呢?
大而化之,可以将文档的“Just enough”归纳到三种不同的极端需要: 1,通过文档,只要让明天加入这个团队的新人了解所要知道的内容就行了,不在文档中的内容,团队老成员会通过诸如结对、协作等等方式告诉新人; 2,通过文档,可以处理当前项目结束后的维护,或者是后续跟进项目。 管理层和敏捷团队自身可以考察团队的稳定性,项目所处阶段来判断需要什么样的文档。如果团队成员离职率高,文档需要就大,如果项目处于晚期阶段&# |
Just enough(刚刚好)的软件开发文档什么样?
最新推荐文章于 2022-06-17 08:57:57 发布