BT

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

两种类型的敏捷文档——不多不少,刚刚好!

| 作者 Vikas Hazrati 关注 0 他的粉丝 ,译者 金毅 关注 0 他的粉丝 发布于 2009年8月18日. 估计阅读时间: 3 分钟 | CNUTCon 了解国内外一线大厂50+智能运维最新实践案例。

敏捷宣言提出:“可以工作的软件胜过面面俱到的文档”。这使得很多团队认为敏捷项目中不需要有文档。敏捷评论家们纷纷把有限的文档看作敏捷方法学的弱点。Ron Jeffries提出,敏捷并非推崇不需要文档或很少的文档,而是强调适当的文档化。他提到,

大家对于XP的那个最普遍的质疑其实并不正确。他们认为我们觉得文档化是个坏主意。而XP其实致力于将对话的效率最大化。我们关于文档化的建议正是由此而来的。

如出一辙,Eelco Gravendeel也提出敏捷中就只有两种文档

  • 为了保证项目运行,所有团队成员都觉得有需要的文档 ——在理想情况下,团队在同一个地方一起工作,所有的知识可以通过直接交流得到共享和传播。然而,如果是分布式的团队,知识就不得不通过文档进行传播了,附带一些的影音媒介应该更有效。这时团队至少需要有一套共同的文档规范,来保证大家都说“普通话”,能有相同的理解。

Eelco建议:需要多留意许多用于产品立项的文档,因为项目一结束它们就没用了;也就是说,

一旦你承认,这些文档仅仅是为了符合产品立项流程而写的,当项目结束或产品发布以后,它们就没用了,那么,理所当然地,对那些主张你把文档做全并保证100%正确的声音,你就可以开始说不了!这就是为何写文档是项旷日持久(而且昂贵!)的工作的原因。一旦你认识到这一点,其实只需要写 到刚刚够用,能传话、起到备忘作用就好了,你也会理解形式也不那么重要了:写在纸上、给白板上的图拍个照、茶杯垫后面的草稿、story board等都行。
  • 最终产品的附带文档 ——这是一些和客户事先定好的、作为产品一部分发布的文档。比较典型的例子包括

  1. 用户手册
  2. 发布手册
  3. 维护手册(用于操作软件)
  4. 技术文档(用于维护代码)等。

对这些文档,Eelco甚至还建议到:

尽管已经确定哪些文档需要附在产品中,你还是可以在文档的形式上做一些创新。你可以写个冗长的用户手册,抑或用更多2.0的技术,像屏幕投影(screen casting),来做文档。后者通常比较便宜(据统计大概便宜10倍!),而且可能实际上更加实用。

因此,敏捷中就需要两种文档,一种是对团队有帮助的,另一种是要和最终产品一起发布的。如果一个敏捷团队正在准备一些超出这两类的文档,那就需要多留意一下了。大多时候,团队可以避免做这些文档。

查看英文原文:Two Types of Agile Documents - No More, No Less!

评价本文

专业度
风格

您好,朋友!

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

获得来自InfoQ的更多体验。

告诉我们您的想法

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

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

我们应如何确定哪些文档属于这两种类型的敏捷文档? by 魏 波

个人认为提出两种类型的敏捷文档对于我们的工作并没有太大的意义。把这个问题往前推一步,就会发觉问题仍然存在:
1 我们应如何确定某个文档是“为了保证项目运行,所有团队成员都觉得有需要的文档”,而另一个不是?
2 除了作者提到的4种文档,还有没有其它文档也是“最终产品的附带文档”?仅这4种对于所有的行业、用户群体都适用吗?此外“技术文档”这个说法显得很含糊,每个人的理解都可以有不同

Re: 我们应如何确定哪些文档属于这两种类型的敏捷文档? by 金 毅

+1,很难定义。还有很多文档是组织级要求的,你能不写?组织觉得需要。

Re: 我们应如何确定哪些文档属于这两种类型的敏捷文档? by 徐 毅

也许你们的组织级领导人尚未意识到不必须的文档是一种浪费?

Re: 我们应如何确定哪些文档属于这两种类型的敏捷文档? by wang egmkang

尚未意识到怎么办?

Re: 我们应如何确定哪些文档属于这两种类型的敏捷文档? by 徐 毅

噢,对我来说非常简单。我会告诉领导这是浪费,然后就是领导做选择的时间了。如果他/她的选择我不喜欢,那么“是否违心地执行领导的决定还是。。离开?”就是我的选择了。

一篇完全正确的废话 by 江南 白衣

都2009年了,这样的观点说了等于没说。

Re: 我们应如何确定哪些文档属于这两种类型的敏捷文档? by li tianyi.

如果领导选择的是我不喜欢的,一般我就跟领导说“哦,要做这些文档的话项目的工期可能就得往后拖一下了...”,或者如果那时我也没什么事儿的话,写就写呗,反正也没事儿。

说得很好但很含糊 by chu easin

真正敏捷化项目的文档具体有哪些?还是要具体问题具体分析,不可能千篇一律的。

CD by 李 博

很多文档是需要按照客户的过程管理要求,必须提交的,不是开发团队自己说敏捷就做。
另外,一个项目的完整过程,并不仅仅是开发过程,开发是隐藏在水底的工作,很多时候上不了台面,项目越大越是如此。

Re: CD by 卫 威

潜在水底?那项目的风险该有多大啊!

允许的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通知我

10 讨论

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


找回密码....

Follow

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

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

Like

内容自由定制

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

Notifications

获取更新

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

BT