文档章节

敏捷开发需要编写文档吗

一等兵
 一等兵
发布于 2016/03/22 09:38
字数 806
阅读 76
收藏 4

输入图片说明

在产品研发过程中经常需要编写很多文档,例如:需求文档、设计文档、API文档、验收文档等等。团队成员要花费很多精力去维护众多的文档,甚至有“兄弟,我替你写代码,你替我写文档”的无奈。

敏捷开发宣言

  • 个体和互动 胜于 流程和工具
  • 可以工作的软件 胜于 详尽的文档
  • 客户合作 胜于 合同谈判
  • 响应变化 胜于 遵循计划

敏捷宣言的第二条“可工作的软件胜于详尽的文档",很多人理解为敏捷开发不重视文档,甚至以此为借口逃避写文档。同样,在对待"敏捷开发是否需要架构设计”的问题上也有类似极端的看法。

敏捷宣言在写什么样的文档以及如何写方面并没有给出任何刚性的指导原则,那么在敏捷管理的项目中我们该如何编写文档呢?

首先,我们需要理解敏捷宣言背后的思想。 敏捷4条宣言都是在强调“价值”、“快速交付价值”、“为客户提供价值”的理念。换句话说,研发团队要把精力放在能够为客户带来价值的地方,避免在不产生价值或者ROI(投入回报率)低的任务上浪费时间。

其次,我们要理解文档的作用是什么?文档是用来准确传递信息,帮助理解事物,沉淀知识。

基于以上理解,在遇到是否要写文档的疑问时,可以通过回答两个问题来判断

  • 是否有比写文档更高效传递信息的方式?
  • 简陋的文档是否满足需要?

从文档的读者来划分

  • 读者是项目组外人员 这类文档往往是需要编写的而且不能“简写”的。例如:用户手册、验收文档、API文档等。

  • 读者是项目组内人员 这类文档能省则省,能简则简。如果能够在每天站会上沟通的,就可以不写。建议高层的系统架构图、内部API文档可以简写。 如果项目Leader通过类似EasyPM这样管理工具能够查询到的信息,可以在周报中简写甚至省略。

对于可以“简写”的文档,可以考虑使用Markdown格式。

Markdown是一种简单易用的标记语言,用户可以使用这些标记符号以最小的输入代价生成极富表现力的文档。

EasyPM 的文档编辑器使用Markdown语法,并且实时保存/预览、支持代码高亮、文档评论以及全文搜索。在版本管理上,支持手动和自动进行版本管理。文档评论也支持@功能,可以高效地对文档进行评审。

© 著作权归作者所有

共有 人打赏支持
一等兵
粉丝 5
博文 4
码字总数 2896
作品 0
郑州
为什么不能照搬以前的成功经验?

如果只是为了提高质量,我有很多经过验证的、成熟的经验,不过这些经验很多并不适用于当前的情况。 我经常在考虑,我们公司的竞争优势在哪里,或者我们公司希望在未来的三到五年保持或者创造...

青春的小奋斗
06/14
0
0
敏捷软件开发与传统软件开发的对比

敏捷软件开发与传统软件开发的对比 最早了解敏捷开发是通过大二的一次博雅课堂,一位在百度工作的北航学长跟我们分享了他近年来从事敏捷开发的经历。印象最深的一句话是一个延迟3个月交付100...

JackMo2015
01/23
0
0
敏捷开发为何总在ToB中铩羽而归呢?

我在10年ToB的行业产品研发和项目实施的工作中,不止一次听到关于“敏捷开发模式不适合大型ToB项目研发”的观点,坚持该观点的往往也都是资深项目经理和研发Leader。这就很奇怪了,一方面最近...

乌士儿
03/22
0
0
Scrum敏捷研发体系初探

在开始之前还是先来做个对比: 通过以上对比,我们发现,每一种研发过程模型都是在一定的历史背景下形成的,而且有各自的使用场景。当下“互联网+” 已深入人心,软件行业也在适应时代变化要...

yown
2016/07/30
0
0
偶然成为敏捷人士:个人回望《敏捷宣言》发布十年

我不是《敏捷宣言》最早的签署者, 我甚至不是诸如TDD等敏捷实践的最早期采纳者。然而, 回望过去,我认为我是敏捷原则的早期采纳者, 即使当时我没有认识到这一点。 时间盒、增量式开发、持...

二胡
2011/03/12
762
3

没有更多内容

加载失败,请刷新页面

加载更多

下一页

[雪峰磁针石博客]软件测试专家工具包1web测试

web测试 本章主要涉及功能测试、自动化测试(参考: 软件自动化测试初学者忠告) 、接口测试(参考:10分钟学会API测试)、跨浏览器测试、可访问性测试和可用性测试的测试工具列表。 安全测试工具...

python测试开发人工智能安全
今天
2
0
JS:异步 - 面试惨案

为什么会写这篇文章,很明显不符合我的性格的东西,原因是前段时间参与了一个面试,对于很多程序员来说,面试时候多么的鸦雀无声,事后心里就有多么的千军万马。去掉最开始毕业干了一年的Jav...

xmqywx
今天
2
0
Win10 64位系统,PHP 扩展 curl插件

执行:1. 拷贝php安装目录下,libeay32.dll、ssleay32.dll 、 libssh2.dll 到 C:\windows\system32 目录。2. 拷贝php/ext目录下, php_curl.dll 到 C:\windows\system32 目录; 3. p...

放飞E梦想O
今天
0
0
谈谈神秘的ES6——(五)解构赋值【对象篇】

上一节课我们了解了有关数组的解构赋值相关内容,这节课,我们接着,来讲讲对象的解构赋值。 解构不仅可以用于数组,还可以用于对象。 let { foo, bar } = { foo: "aaa", bar: "bbb" };fo...

JandenMa
今天
1
0
OSChina 周一乱弹 —— 有人要给本汪介绍妹子啦

Osc乱弹歌单(2018)请戳(这里) 【今日歌曲】 @莱布妮子 :分享水木年华的单曲《中学时代》@小小编辑 手机党少年们想听歌,请使劲儿戳(这里) @须臾时光:夏天还在做最后的挣扎,但是晚上...

小小编辑
今天
68
8

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部