写点什么

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

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

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

关注

评论

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

朋友圈系统架构设计

Geek_8d5fe5

架构实战营

Redis 在 vivo 推送平台的应用与优化实践

vivo互联网技术

服务器 消息推送 redis'

Mac 鼠标手势软件 -- MacStroke

TroyLiu

效率工具 推荐 Mac 鼠标手势 Mac 软件

取代 Mybatis Generator,这款代码生成神器配置更简单,开发效率更高!

沉默王二

手写简易版 React 来彻底搞懂 fiber 架构

CRMEB

前端培训:React调度算法迭代过程

@零度

前端开发 React

jQuery常用方法归纳总结

编程江湖

重磅消息·OpenMLDB官方网站 今日正式上线!

第四范式开发者社区

人工智能 机器学习 开源项目 AI Studio 特征平台

Spring Cloud Alibaba Nacos路由策略之保护阈值!

王磊

spring cloud alibaba

大数据培训:Flink调度器性能的提高

@零度

flink 大数据开发

react源码解析6.legacy模式和concurrent模式

buchila11

React

我做基础架构学到的42件事

多颗糖

数据库 架构 架构师 基础架构

HiveSQL高级进阶10大技巧

编程江湖

第十一节:Springboot整合log4j2日志

入门小站

spring-boot

在线YAML转HTML工具

入门小站

工具

霜皮剥落紫龙鳞,下里巴人再谈数据库SQL优化,索引(一级/二级/聚簇/非聚簇)原理

刘悦的技术博客

sql 优化 SQL优化 MySQL优化 :MySQL 数据库

在低代码开发时代,还需要IT部门吗?

TOBESOFT特碧软件

低代码 数字化 TOBESOFT

运维工程师的工作内容有哪些?能详细列举一下吗?

行云管家

云计算 运维 系统运维 IT运维

建木持续集成平台v2.2.2发布

Jianmu

DevOps CI/CD 自动化运维

Java最简单可靠的线上不停机发布方案

游牧

警惕!Python 中少为人知的 10 个安全陷阱!

Python猫

Python

java培训:MyBatis高级进阶学习分享

@零度

mybatis JAVA开发

手写一个线程池,带你学习ThreadPoolExecutor线程池实现原理

华为云开发者联盟

Java 线程 线程池 ThreadPoolExecutor

用户登录功能:说简单也困难

华为云开发者联盟

安全 cpu 加密算法 TPS 用户登录

分布式事务管理DTM:“买买买”背后的小帮手

华为云开发者联盟

微服务 电商 分布式事务管理 DTM 云图说

TDengine在TCL空调能源管理平台的实践

TDengine

数据库 大数据 tdengine 物联网

11个基于HTML/CSS/JS的情人节表白可爱小游戏、小动画

海拥(haiyong.site)

大前端 情人节 表白 2月月更

[C语言]打开C的大门

謓泽

入门 C语言 编程、 2月月更

大数据存储领导厂商创新科加入,携手龙蜥社区共建开源生态

OpenAnolis小助手

大数据 Linux 开源 云存储

Go学习笔记——常量

为自己带盐

Go 学习笔记 2月月更

mycat 中间件安装与使用

编程江湖

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