QCon 演讲火热征集中,快来分享技术实践与洞见! 了解详情
写点什么

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

  • 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:412783
用户头像

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

关注

评论

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

FlinkX 如何读取和写入 Clickhouse?

Apache Flink

flink

cookie和session的关系看这一篇就够了

架构师修行之路

session Cookie

第九周

Acker飏

2020-08-29-第十二周学习总结

路易斯李李李

Week 12 学习总结

Jeremy

互联网人必备知识cookie和session认证

架构师修行之路

分布式 身份认证 session Cookie

AtlassianTeam Playbook | 用户体验中的移情地图

Atlassian

团队管理 敏捷开发 Atlassian

你真的知道什么是线程安全吗?

老胡爱分享

并发编程 线程 java 并发

2020-08-29-第十二周作业

路易斯李李李

我所在公司和大数据

2流程序员

Docker 私有镜像仓库的搭建及认证

哈喽沃德先生

Docker 容器 微服务 镜像

架构师训练营第十二周作业

Hanson

计算机网络基础(二十二)---传输层-套接字与套接字编程

书旅

TCP 计算机网络 TCP/IP

云算力挖矿平台APP,算力挖矿建设开发

13530558032

kubernetes node affinity 写法

Geek_f24c45

Kubernetes

架构师训练营 -- 第 12 周作业

stardust20

oeasy教您玩转linux010201持续输出yes

o

大数据解答(一)

dony.zhang

大数据 mapreduce

架构设计开学第一天

escray

学习 从零开始学架构 架构师预科班

42图揭秘,「后端技术学些啥」

我是程序员小贱

Flink SQL FileSystem Connector 分区提交与自定义小文件合并策略

Apache Flink

flink

区块链支付新模式开发,USDT支付系统搭建

13530558032

Atlassian Team Playbook | 用户体验画布挖掘业务价值

Atlassian

团队管理 敏捷开发 Atlassian

听说,阿里云给它的 OpenAPI 开发了一套编程语言

郭旭东

阿里云 OpenAPI

所按非所得——聊一聊StandHogg漏洞

OPPO安全

安全攻防 安全 安全开发 漏洞

3种 Springboot 全局时间格式化方式,别再写重复代码了

程序员小富

Java springboot

大数据应用场景

dongge

【Spring Boot系列】之多种依赖集成方式

语霖

Week 12 命题作业

Jeremy

甲方日常 5

句子

工作 随笔杂谈 日常

微服务架构下的系统集成

码猿外

架构 微服务 系统集成

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