写点什么

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

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

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

关注

评论

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

深入剖析 FastAPI 多线程的最佳实践

Liam

Python 程序员 性能优化 后端开发 FastApi

软件测试/测试开发丨UI自动化测试用例结构分析

测试人

Python 程序员 软件测试 自动化测试 测试开发

低代码是什么?能做什么?

树上有只程序猿

低代码 应用开发

【附 Demo】悦数图数据库推出 Graph RAG: 减少大模型“幻觉”,优化向量数据库检索能力

最新动态

Git 速查表:中级用户必备的 12 个 Git 命令

Se7en

软件测试|Python科学计算神器numpy教程(十一)

霍格沃兹测试开发学社

GitHub Copilot三连更:能在代码行里直接提问,上下文范围扩展到终端

Openlab_cosmoplat

人工智能

关于信创技术你需要了解这些概念

Onegun

操作系统 中间件 信创产业 信创生态

WebVR — 网络虚拟现实

3D建模设计

WebVR

软件测试|Mac安装appium报权限问题

霍格沃兹测试开发学社

3D 碰撞检测

3D建模设计

3D 碰撞检测

软件测试|SQL AND和OR运算符解析

霍格沃兹测试开发学社

软件测试|自动化界面操作神器pywinauto教程(一)

霍格沃兹测试开发学社

com.google.guava:guava 组件安全漏洞及健康分析

墨菲安全

组件 组件健康度

WebAssembly 在云原生中的实践指南

Se7en

org.mockito:mockito-core 组件安全漏洞及健康度分析

墨菲安全

组件 组件健康度

6 个用于 3D 网页图形渲染的最佳 WebGL 库

3D建模设计

图形引擎

WebGL:基于web的交互式2D/3D图形引擎

3D建模设计

JavaScript WebGL

Java实现学生信息管理系统读取Excel数据

飞算JavaAI开发助手

com.squareup.okhttp3:okhttp 组件安全漏洞及健康度分析

墨菲安全

组件 组件健康度 组件安全漏洞

火山引擎开源通用多媒体处理框架 BMF

字节跳动开源

开源 框架 视频云 多媒体

软件测试|Python科学计算神器numpy教程(十)

霍格沃兹测试开发学社

Katalyst:字节跳动云原生成本优化实践

字节跳动开源

开源 Kubernetes 运维 云原生 成本优化

【升职加薪秘籍】我在服务监控方面的实践(2)-监控组件配置

蓝胖子的编程梦

elasticsearch Prometheus 服务监控 #Grafana 微服务监控

WebGPT VS WebGPU

3D建模设计

webgpu webgpt

提升开发能力的低代码思路

互联网工科生

软件开发 低代码 企业级应用程序开发

全球选手逐鹿清华!首届AI药物研发算法大赛完美收官

飞桨PaddlePaddle

人工智能 百度飞桨 飞桨国赛

软件测试|如何更新已经安装的Python第三方库

霍格沃兹测试开发学社

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