BT

如何利用碎片时间提升技术认知与能力? 点击获取答案

敏捷文档编制路线图

| 作者 Ester F. Gonçalves 关注 1 他的粉丝 ,译者 李清玉 关注 0 他的粉丝 发布于 2014年7月30日. 估计阅读时间: 13 分钟 | CNUTCon 了解国内外一线大厂50+智能运维最新实践案例。

介绍一下我的朋友Jane和John。

John是一家大型公司的长期分析师,负责捕获新的软件产品及现有软件产品的需求。他用SRS(软件需求规格说明书)记录所有客户对正在开发或维护的特定产品的需求。

Jane是同一家公司的开发人员。她通常接收John的软件需求规格说明书(SRS),而后开始对要实现的内容进行技术分析和设计。完成分析之后,她就开始写代码实现。

我的这两个朋友John和Jane的需求文档和设计文档都需要经过审批;对于John来讲,把需求文档发给Jane之前需要经过审批,而对Jane来讲,则是在开始写代码之前要经过审批。

最近,John和Jane所在的公司采用了敏捷方法来作项目管理和软件研发,这使得他们的工作方式发生了改变。不需要制定大量的前期需求和设计,需求说明书和开发都被切成了小块的信息,摒弃了使用多年的大篇幅文档。开发人员的开发方式也发生了变化,鼓励像实现之前先做测试设计和用较长的名字来命名函数等这样的做法。

不出所料,John和Jane提出了一大堆的问题:

  • 如果我们无法提前知道要开发什么,那我们怎么开始开发呢?
  • 那些功能资料如果不记录在往常所用的SRS中,那么记录在哪里呢?
  • 我们如何了解要开发的所有详细信息?
  • 用于未来维护的说明文档和代码放在哪里?
  • 如果没有写文档的阶段,那么我们什么时候写文档呢?

在过去十年中,敏捷方法在项目管理和软件开发中的应用经历了迅速发展的阶段,并预计将持续地增长。在向敏捷过渡的过程中,看似宽松的开发方式完全不同,做事不再那么传统,为此,世界各地的许多人都会和John、Jane一样抛出如上同样的问题。

当公司开始过渡到敏捷理念的过程中,一些工作方式的差异都与文档有关。

本文将重点讲述为什么、什么时候、如何以及在哪里编制技术和功能文档。

文档编制与敏捷理念

敏捷宣言中宣称的价值观是:

个体和互动 高于 流程和工具
工作的软件 高于 详尽的文档
客户合作 高于 合同谈判
响应变化 高于 遵循计划

尽管提到了文档,但敏捷原则在如何编制文档方面并没有给出任何刚性的指导原则。

因此,在敏捷管理的项目中我们应该期待产出什么样的文档呢?

敏捷理念背后的原则是,强调为客户实现价值。这就意味着我们应该把产品开发的时间花在能够为客户带来价值的那部分,避免在几乎没有什么价值的任务上浪费时间。该原则也同样适用于文档的编制。

在传统的瀑布方式中,文档是一个预定义的阶段,它需要花费大量的时间。过渡到敏捷则意味着我们必须重新思考编写文档的方式,以避免把时间浪费在价值具有争议的交付成果上。

这是否意味着我们不需要编制任何文档呢?其实不是这样的。

另一个敏捷原则是适应变化。那就意味着我们不能提前做太多的计划,因为事情在项目进行中会有所变化。所以,我们永远专注的是适时的计划。这一条也同样适用于文档。为了避免浪费时间,我们应该只在需要文档时才去编写它。

但是,我们如何知道它何时需要呢?

真的需要文档吗?-为什么需要文档

如果你来自瀑布的领域,那么很自然就会带过来定义大量文档的习惯,但这样会导致:

  • 编写了很多不必要的详细信息。
  • 编写的是传统的规格说明书,敏捷只是一个名字而已。

为了避免这个情况,有一些指导方针帮助我们决定是否真的需要编制文档。

为避免在文档上浪费时间,向每个相关的人问如下问题:

  • 这个文档是用来做什么?是支持开发吗?还是提供功能的参考文献?
  • 文档的目标受众是谁?什么人?哪个部门的?他是客户吗?或者是未来的维护团队?
  • 这些目标受众如何使用这篇文档?是一个参考文献吗?还是一个手册?
  • 编制这些文档需要多少成本?需要多少时间?由谁来完成?

决定是否需要文档的一个关键因素是,只定义正好够用的文档。在干系人真正需要的和完整的内容之间寻找平衡点。不多不少,恰到好处。

何时,在哪,编制什么文档

对为什么编制文档和编制多少文档达成共识之后,在开始编制之前还需要定义要编制什么样的文档。

什么样的文档

根据文档的目标受众来编制相应的文档。教程?培训材料?维护支持文档?业务规则文档?还是系统描述文档?

在项目的每一阶段规定需要什么样的技术文档和功能文档,从而来确定编制什么文档:

  • 在项目开始之前,需要什么样的文档?
  • 在项目中期 ,需要什么样的文档?
  • 在产品开发完毕或者产品推出后,需要什么样的文档?

在哪

在一个易于访问的并可不断更新的资源库中保存文档对保持文档的可用性非常有帮助。用Word文档或类似的格式会让其变得陈旧或过时。

随着项目的滚动进行,文档应当长期保持更新,保持文档对目标受众的有效性。

何时

不像在瀑布式开发所期待的那样,在敏捷开发中没有文档阶段。

因此,当功能以增量的方式开发时,文档的编制也应该是增量的,与产品开发一起演进。

如何编制文档

在这一点上我们应该决定:

  • 编制刚好够用的文档。
  • 编制什么文档。
  • 文档存在哪里,如何保持有效性。
  • 什么时候编制文档。

在项目的每一个阶段如何编制文档呢,现在让我来提供一些建议和最佳实践。

项目启动文档

在项目初期阶段,只需要少量的文档,因为真正的工作就是如何开始。

当开始编制技术文档时,定义你选定的两个或者三个高层次的架构图,并定义解决方案中需要实现的高层次组件。

在功能方面,用史诗(Epics)来定义产品需要开发的主要特征就可以了。

因为要用敏捷的方式管理项目,不要求预先设计,所以在这个阶段,定义够用的信息,让团队开始工作就足够了。

项目文档

在项目进行阶段,随着产品的增量开发,可能需要编制两种类型的文档:

A恰到好处的需求文档-作为产品待办事项列表(Product Backlog)的输入。

B.要实现的系统和业务逻辑-作为每个迭代的输出。

每一种文档都有它自己的目标受众:

目标受众A: 团队。

目标受众B干系人和最终的维护团队。

这些文档需要对这两类目标受众的需求给出回应。

功能文档

用户故事是敏捷管理项目中最常用的功能文档。用户故事汇聚了足够的信息,告诉开发人员如何实现这些需求,它是用下面的格式描述的:

  • 描述:用“作为<角色>,我想要<功能>,因此我可以<给客户带来的价值>”这样的形式。
  • 验收标准:定义故事是否完成的标准,让团队和产品负责人对此达成一致。

在迭代计划之前,用户故事的需求描述必须经过干系人的认可,这意味着现在它们已经为计划的迭代做好了准备,它们应该有可靠的信息来源(需求),开发人员知道要实现什么。这需要对目标受众A提供足够的信息。

当用户故事正在开发中时,团队可能会确定新的验收标准,然会添加到用户故事中。

记住,在敏捷中,用户故事不应该是一小块非常详尽的需求描述,而是希望提供什么功能实现的指导方针,这是产品负责人和团队之间未来合作要实现什么产品的承诺。

当用户故事开发完成并被干系人接收之后,那么就可以认为它是已接收的了。这个时候,用户故事需要从Product Backlog(需要实现的一系列功能需求描述列表)中挪到Product Increment(在迭代及所有之前的迭代中已完成的一系列产品代办列表)。

当用户故事以增量的方式完成时,目标受众B所需要的文档在下图1中显示。

技术文档

在研发阶段,开发人员需要运用一些公认的最佳实践(作为敏捷开发方法的一部分),例如测试驱动开发TDD(Test-Driven Development)和行为驱动开发BDD(Behavior-Driven Development),以及结构良好的代码、非技术人员可读等。这个需要提供描述代码的技术文档。

最新的功能和技术文档

因为代码是最新的业务规则和系统实现的最可靠来源,因此基于代码本身是拥有有效文档的最佳方式。

活文档是实现它的一种方式。

活文档或动态文档是持续编辑和更新的文档。活文档的概念依赖于在代码中集成的文档,该文档是基于验收标准,用领域专用语言(Domain Specific Language)来写的,例如用于Cucumber的Gherkin。通过工具来辅助活文档的持续构建,写在用户故事中的验收标准作为代码的一部分已经实现了,并且以一种可读的格式在更新的、典型的在线地址上输出。

提供活文档机制的一些工具包括:CucumberConcordionFitNesseSpecFlow

Pickles,以及其他。他们都值得一看。

项目后期文档

由于文档是随着用户故事的实现增量编制的,在开发周期结束和产品推出后,那些技术和功能文档应该描述了所有的功能实现。

归纳

当决定需要编制多少文档时,很重要一点是要定义多少文档是刚好够用的文档。

图2描绘了本文中所推荐的用来决定文档编制的路线图。

在确定了为什么、做什么、什么时候做、怎么做之后,就要用敏捷的方式定义编制文档的最佳实践,用敏捷软件开发的技术和活文档。

表格1中列出了每一阶段推荐的文档输出内容。

 

项目前期文档

项目中期文档

项目后期(维护)文档

技术

选择的两个或三个高层次架构图

结构良好的代码,无技术基础人员易读

测试驱动开发 (TDD)

行为驱动开发 (BDD)

以代码为文档

【一次一个用户故事】

代码作为技术文档

功能

主要的史诗定义产品需要开发的主要特征

具有定义良好的用户故事,清晰的验收标准

以验收标准为文档

【一次一个用户故事】

代码作为活文档

总结

如同我的两个虚拟朋友Jane和John所经历的一样,对任何的团队来说从传统的瀑布式到敏捷开发的过渡都是一种挑战。人们的工作方式已经沿用了几十年,当发生转变时,就会引发各种问题和质疑。

在所有这些由团队协作方式的转变(尤其是在思想意识上的转变)而引起的问题和质疑中,文档是一个主要的问题,这是其中变化最大的一个--从开发之前编制所有文档变成同一阶段几乎不怎么写文档。

敏捷的基本原则并没有说不需要任何文档,只是提醒团队应该注重给客户交付的价值。在编制文档的过程中,也应该考虑这一关键原则。

所以,编制文档时请记住,只在需要的时候编制必要的文档,不多也不少。

提醒你的团队要适时地编制恰到好处的文档。

关于作者

在大约二十年前,Ester F. Gonçalves作为一名开发人员和系统分析师开始了她的职业生涯。在最近的四年里,她决定研究IT的业务领域。她在敏捷管理的团队中从事IT业务分析工作,成为了一名敏捷爱好者,研究敏捷方法论、系统和业务分析技术,撰写和发表了多篇相关的文章和博客,偶尔在会议和研讨会上发表这些主题的演讲,并且渴求自己做得更好。

查看英文原文http://www.infoq.com/articles/roadmap-agile-documentation


感谢夏雪对本文的审校。

给InfoQ中文站投稿或者参与内容翻译工作,请邮件至editors@cn.infoq.com。也欢迎大家通过新浪微博(@InfoQ)或者腾讯微博(@InfoQ)关注我们,并与我们的编辑和其他读者朋友交流。

评价本文

专业度
风格

您好,朋友!

您需要 注册一个InfoQ账号 或者 才能进行评论。在您完成注册后还需要进行一些设置。

获得来自InfoQ的更多体验。

告诉我们您的想法

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我
社区评论

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

讨论

登陆InfoQ,与你最关心的话题互动。


找回密码....

Follow

关注你最喜爱的话题和作者

快速浏览网站内你所感兴趣话题的精选内容。

Like

内容自由定制

选择想要阅读的主题和喜爱的作者定制自己的新闻源。

Notifications

获取更新

设置通知机制以获取内容更新对您而言是否重要

BT