BT

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

敏捷文档:雾里看花?

| 作者 Amr Elssamadisy 关注 0 他的粉丝 ,译者 郑柯 关注 3 他的粉丝 发布于 2010年3月25日. 估计阅读时间: 3 分钟 | Google、Facebook、Pinterest、阿里、腾讯 等顶尖技术团队的上百个可供参考的架构实例!

“可工作的软件胜过全面的文档。”2001年的敏捷宣言如是说。

文档相关的主题在敏捷社区里面还是比较模糊吧?我们应该创建多少文档?哪些做法可行?哪些不行?关于文档,我们该如何从传统的流程切换到敏捷流程?是的,这个领域在敏捷社区中模糊不清。

最近在Zen Agile上有一篇帖子提出这样的问题:“要写多少文档才算足够?”作者谈及自己与政府部门的工作经历,并分析了他们重量级文档流程背后的原因:

曾有人告诉我:所有的文档都是必要的,“因为我们是政府”。深入一点之后,我发现如下原因:
  1. 有了完整的信息,业务才能得以签字并批准开始构建。
  2. 开发人员需要知道系统的设计目标。
  3. 其他开发人员需要知道系统的构建方式,以做出改进。
  4. 其他开发人员需要知道系统的构建方式,以进行维护。
  5. 政府需要足够的信息来了解花钱的原因和方式。
在我的经验中,不管怎么样,业务中很少有人真正理解需求文档。他们想通过了解项目背景来确定当前的状态,以及项目的发起原因得到明确说明。也许他们会查看业务流程图,因为项目的图形说明要比用例更易于理解。不过总体看来,让他们签字通过批准没有见过的东西,这有点……呃……就是不太合逻辑。

博客文章接下来讲述了文档的一种变通方式,包括如下内容:

  1. 以人物角色(personna)、场景和上下文图的方式明确阐述上下文。
  2. 使用流程图和跟踪矩阵描述需求。
  3. 使用数据模型、站点地图、导航设计和UI设计记录解决方案。
  4. 使用原型验证解决方案。这里要签字,而且要反复签。
  5. 记录系统构建,包括代码、测试方法和物理数据模型。

上面的流程已经过反复思索,而且来自实际经验。但是这跟我们在社区里的通用做法接近吗?

已经有很多关于用户故事、用例和以测试作为需求规范(tests as specification)的对话了。但是就只有这些了吗?已经有一本关于敏捷文档的书了,可在研究敏捷文档这个主题前,笔者从未听说过。其中有一章讲到起到唤醒记忆和表达作用的文档。甚至早在3年之前,InfoQ就已经有一篇关于这个主题的新闻了。

关于文档,我们能否达成共识?甚至是否存在几个不同的“思想流派”?很难说,因为这个主题没有多少文字记录。也许它太简单了,因此没人记录。或者也许它太复杂了,推荐什么样的做法,我们也真的没有什么好主意。InfoQ的好读者们?有什么想法吗?

查看英文原文: Agile Documentation: Is There Clarity?

评价本文

专业度
风格

您好,朋友!

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

获得来自InfoQ的更多体验。

告诉我们您的想法

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

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

人员的稳定性与文档 by 侯 伯薇

我觉得,在开发团队中,文档的作用与人员的稳定性会有一定的关系。如果人员非常稳定,那么再详细的文档也比不上这一点;相反,如果人员流动非常快,那么再详细的文档也没啥用,哈哈。

Re: 人员的稳定性与文档 by 李 冬

这和作者说的没什么关系吧 作者大概想表达文档对于敏捷编程也是必要的 敏捷编程重来也没有太排斥文档 只是优先级方面低于可以工作的软件 我的理解是 在软件正常工作之前 文档不应该成为工作绝对的重点

只有组织的成功才是真正的成功 by Xu Liang

在《敏捷开发的艺术》开篇就提到组织的成功才是我们的目标。

“政府需要足够的信息来了解花钱的原因和方式。”就这一条就决定了文中所述的场景文档是必需的。剩下的问题就是让文档上的投入如何更有价值的问题了。

Re: 只有组织的成功才是真正的成功 by Dong Nan

同意

从客户的角度看,文档不可避免。 by Dong Nan

初次打交道的客户必须需要详细完整描述清楚的文档,内容粒度非常细,即使有相关人员负责与客户沟通,但对减少文档没有帮助。如果是老客户,一般采取敏捷开发,项目后期或完成后由设计人员,业务人员,开发人员共同文成文档。因为有的项目文档是必须的,客户需要这个。有的项目需要通过审计人员的审计,而文档是必须的。

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

5 讨论

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


找回密码....

Follow

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

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

Like

内容自由定制

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

Notifications

获取更新

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

BT