写点什么

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

  • 2009-08-16
  • 本文字数:948 字

    阅读完需:约 3 分钟

敏捷宣言提出:“可以工作的软件胜过面面俱到的文档”。这使得很多团队认为敏捷项目中不需要有文档。敏捷评论家们纷纷把有限的文档看作敏捷方法学的弱点。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!

2009-08-16 23:412843
用户头像

发布了 114 篇内容, 共 34.9 次阅读, 收获喜欢 2 次。

关注

评论

发布
暂无评论
发现更多内容

PassJava 开源 (三):快速生成前后端代码

悟空聊架构

SpringCloud 28天写作 passjava 悟空聊架构 12月日更

视频知识点(6)- MPEG vs JPEG

liuzhen007

28天写作 12月日更

为何建议大家升级到Kafka2.5.x?

Kafka中文社区

单步调试理解webpack里通过require加载nodejs原生模块实现原理

汪子熙

前端 前端开发 webpack 28天写作 12月日更

【架构实战营】模块七作业

liu🍊

性能分析之TPS从300到750的过程

zuozewei

性能测试 性能分析 12月日更

synchronized的使用及优化

Ayue、

synchronized

管理文化

圣迪

管理 文化 强势文化 弱势文化

【CSS 学习总结】第三篇 - CSS 选择器的权重和优先级

Brave

CSS 12月日更

Python 的元类设计起源自哪里?

Python猫

Python ruby

leetcode 206 反转链表

好吃不贵

一个支持断点续传的大文件分片上传的小模块

为自己带盐

dotnet 28天写作 文件上传 12月日更

王者商城异地多活设计

天天向上

架构实战营

Dubbo 框架学习笔记十

风翱

dubbo 12月日更

22《重学JAVA》--字节流

杨鹏Geek

Java25周年 28天写作 12月日更

dart系列之:和null说再见,null使用最佳实践

程序那些事

flutter dart 程序那些事

k8s daemonset controller源码分析

良凯尔

源码 Kubernetes 源码分析 源码解析 #Kubernetes#

Java 中接口和抽象类的 7 大区别!

王磊

分布式数据缓存中的一致性哈希算法

程序员历小冰

缓存 一致性哈希 28天写作 12月日更

如何设计异地多活架构

天天向上

架构实战营

盘点2021|「避坑宝典」为大家分享一下笔者在2021年所遇到“匪夷所思”的Bug趣事(上)

码界西柚

2021年展望 2021年度技术盘点与展望 盘点2021 避坑宝典

DDD领域驱动实战(二)-限界上下文(bounded context)

JavaEdge

12月日更

架构营模块七作业

GTiger

架构实战营

绩效沟通准备

搬砖的周狮傅

绩效管理

040022-week7-design

InfoQ_70156470130f

Kafka的Topic和Partition是不是有个数限制?

Kafka中文社区

PassJava 开源 (四):整合MyBatis-Plus实现CRUD

悟空聊架构

mybatis 28天写作 passjava 悟空聊架构 12月日更

蓝绿发布、滚动发布、灰度发布

xcbeyond

灰度发布 28天写作 12月日更 蓝绿发布 滚动发布

2021的科技卦象·兑·一场“双碳”催化雨

脑极体

Prometeus 2.32.0 新特性

耳东@Erdong

Prometheus 28天写作 12月日更

前端开发:Mac OS环境下的通过对Chrome浏览器设置SameSite解决跨域请求方法

三掌柜

28天写作 12月日更

两种类型的敏捷文档——不多不少,刚刚好!_研发效能_Vikas Hazrati_InfoQ精选文章