敏捷开发需要的文档_敏捷开发需要哪些文档 - CSDN
  • 敏捷开发需要编写文档吗?

    千次阅读 2016-03-21 16:41:26
    在产品研发过程中经常需要编写很多文档,而敏捷宣言的第二条“可工作的软件胜于详尽的文档",那么需要编写文档吗?有没有简单的判断方法呢?

    easypm-敏捷开发

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

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

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

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

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

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

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

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

    从文档的读者来划分

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

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


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

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

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

    展开全文
  • 敏捷开发需要哪些文档

    万次阅读 2018-01-17 07:39:23
    敏捷开发需要哪些文档? 需求说明 对功能、交互方式、出错或边界情况的表现进行总体描述 1.画面图 2.数据图 3.需求说明 来源张永光的博客

    敏捷开发需要哪些文档?

    需求说明
    
        对功能、交互方式、出错或边界情况的表现进行总体描述
    
    1.画面图
    
    2.数据图
    
    3.需求说明
    

    来源张永光的博客

    展开全文
  • 项目管理---敏捷开发---到底要不要写文档

    万次阅读 多人点赞 2014-04-04 08:29:47
    开发要有开发文档(需求文档、数据库设计、概要设计)、开发计划(甘特图、燃尽图)、测试计划(时间、地点、人员、任务模块分配、禅道bug提交管理)都应该有一个时间段,在大家的一起商量之下可以每个人做到心中...

    故事情节

        最近第二次迭代时,我们带领的开发小组长文哲,这两天在补需求文档、部署文档(二次迭代完成了哪些客户需求?未完成的?),在迭代开发之前就应该有一个文档即是不全,那该多好啊,不用现在这么着急的补充啦。

        思考:倘若没有文档,给客户迭代完后,如何表明我们所做的内容呢?客户是否满意呢?如果没有文档,和客户的交流验收时就很难办了?


    到底要不要写文档?


        记得合作开发的时候,前期花费了很长时间,我们是采用了传统的瀑布模型,需求文档、概要设计、详细设计、数据库设计、甘特图等文档都是前期设计全了,遵循着文档驱动开发,当我们开发过程中到最后,发现文档、图、解决方案根本对不上了,中间修改了很多,相差很多,再验收以前我们三个是饿补啊,在整个开发的过程中由于前期的设计不可能考虑的很详细,每一步不可能考虑的很清楚,最后的文档成了我们头大的问题。


    初设敏捷开发


        自从接触了敏捷开发,我们就体会到这个开发思想不提倡写文档(很爽啊,先开发,当初理解的浅显)我们现在根据客户的需求拿来就开始干了,在这个过程中确实使用着禅道等项目管理工具,但是现在体会还是有些乱,规划的还有很多不合理的地方,给大家的每天的目标还不是很明确(时间段、任务、弹性时间、困难、该完成什么功能?)没有明确的规划,可能会引发项目拖延,时间一长大家会有懈怠心里啦。

        项目一开始,根据客户的需求我们就开始干了,设计、开发、等真正给客户架过去之时发现需求理解的不是很到位、使用还有常见的bug(测试文档没有)等,造成了没有给客户部署成功、我们浪费时间、给客户留下不好印象等等一系列问题,敏捷开发确实可以应对一些变化,但是因为文档不全的问题又一些给大家带来了苦恼。



        今天抽些时间查了敏捷开发的相关资料,敏捷并非不写文档,而是重视文档的作用,也重视文档的维护;它认为文档宜少且精炼,不需要冗余的文档;文档也是作为细化部分,在每个迭代过程中不断重构;一般需求文档、概要设计、详细设计、数据库设计、项目管理文档(甘特图等等)都是必须的,在许多外企的迭代开发中都是这样的,倒是国内的公司确实提倡一种:敏捷无文档,开发效率慢, 基本的文档都是必须的;敏捷开发中的写文档,有了方向性的指导。

    总结

      

        开发要有开发文档(需求文档、数据库设计、概要设计)、开发计划(甘特图、燃尽图)、测试计划(时间、地点、人员、任务模块分配、禅道bug提交管理)都应该有一个时间段,在大家的一起商量之下可以每个人做到心中有数,对任务整体有个全局观,我们每天该干什么?紧急重要的需求?客户迫切需要上线的功能?都有一个好的规划,避免在不必要的文档上(官话、客套话)浪费更多的时间,劲使在刀刃上,提高我们的开发效率,有明确的目标、去按照我们的计划一步步的完成。

        各个工作流自有它的价值……努力吧,继续深入理解敏捷开发理念!

    展开全文
  • 敏捷开发:编写开发文档的利与弊

    千次阅读 2018-09-03 16:49:35
    敏捷开发学习总结: 思考开发文档的利与弊 文档是个好东西,这是不可否认的,但是太依赖文档也有弊端,下面我从不同的度来分析一下文档的利与弊,然后思考在敏捷开发时,文档又是如何进行的。从 公司的角度来看,...

    敏捷开发学习总结: 思考开发文档的利与弊



    文档是个好东西,这是不可否认的,但是太依赖文档也有弊端,下面我从不同的度来分析一下文档的利与弊,然后思考在敏捷开发时,文档又是如何进行的。


    从 公司的角度来看,编写文档有如下好处: 
    a1) 公司使用的是瀑布生命周期(或序列式开发,传统开发),所以必然的,在某一个阶段,需要编写大量的文档作为进入下一阶段的输入。
    a2)过程改进的 需要,认为只要过程控制得足够细,例如只要文档编写得足够详细,那么人员是可以被替换的,也就是说,有了文档,人员的流动不会给项目带来大的风险。
    a3) 受到其它行业的启示,例如建筑行业,图纸制定好并确否没有问题后,施工队才能准确无误地施工,所以要求在编码之前先编写HD、DD文档,除了方便交叉 REVIEW,同时,文档用于指导资浅工程师的编码工作,文档只有编写的足够详细(DD最好给出伪代码),工程师才不至于走偏。
    a4) 企业知识库的建设需要,没有文档,技术就没有得到积累。


    从工程师的角度来看,为什么工程师有时不愿意写文档呢? 
    b1) 代码与文档的同步问题,很多设计文档在写完后就被代码远远地抛在后面了,开发人员只有二个选择,要不更新文档,要不任由文档逐渐地开始撒谎,如果选择维护 文档与代码同步,那么就会耗费大量的时间和精力在文档更新上面,而维护这份文档目的只是为了将来有可能有人需要阅读---也有可能无人问津。
    b2) 任务的工时安排得很紧,但编写文档又导致进度太慢。
    b3)认为文档太枯燥,不比编写代码有成就感。
    b4)没自信,怕文档写不好会误导别 人。
    b5)本身没有搞清楚思路,所以也就写不出文档。


    从敏捷开发思想的角度去看待上述的一些问题: 
    对应 a1) 这就是敏捷开发反对瀑布模型的原因之一吧。
    对应a2) 首先寄望于通过过程控制来达到开发人员可替换性目的这个想法,是有争议的 ,另外,极限编程中使用“代码集成所有权属于团队”的实践方法来保证团队内部的知识共享,从而减少人员流动对团队带来的风险。
    对应a3) 敏捷开发的建议是只写有用的文档,例如编写整个系统的HLD或架构文档是值得的,因为整个团队的成员以及新人都要阅读它来了解整个系统的架构和设计,而某 个模块的DD文档,它的读者只是负责该模块的程序员,敏捷开发的建议是面对面进行交流来传达设计比较来得快捷,不编写过于详细的DD文档的原因是它太容易 与代码脱节了,另外,面对面交流,并不是资深人员传达设计给资浅人员,而是让资浅人员参与到设计中来,是以平等的方式与资深人员一起讨论和确定最终的设 计。可是文档毕竟比起代码易于阅读,总得要有个载体描述模块的DD设计啊,一般来说是推荐“Self-Documenting ”的形式来代替DD文档。
    对 应a4) 轻量级的文档不代表不编写文档,所以这一点与知识库的建设不冲突。
    对应b1) 尽量使用“Self-Documenting”的形式,即将文档以注释的形式插入到代码中,来解决文档与代码的同步问题,需要文档时,再用工具从代码中提 取出文档,例如Java中的JavaDoc工具,而Qt的API文档也是这么干的,Qt的文档是用doxygen来生成的。
    对应b2) 这就是轻量级文档的原则所要解决的问题,除了避免编写无用的文档外,如何避免长篇大论的文档也是要解决的问题,我从UP开发方法的产出物(制品)中了解 到,UP开发方法使用的“用例驱动”方法将需求分析文档以“用例(Use Case) ”的形式来编写,减少了出现长篇大论的可能性。
    剩下的 b3,b4,b5是开发人员自身的原因。


    最好做个总结,文档是好东西,但它的弊端就是要花时间(包括写作和维护的时间),如果项目时间都比较紧,如何把握文档的量和细致程度,确实是值得思考和权衡的问题。

    展开全文
  • 敏捷开发中的文档怎么写

    千次阅读 2018-06-05 13:19:13
    我们比较熟知的软件项目管理方法是瀑布。其基本流程是需求-&...国外的软件先行者们针对瀑布开发中暴露出来的问题进行了一系列的探索、思考和总结,提出了Agile Dev的概念,中文翻译为敏捷开发。一.什么...
  • 敏捷开发中文档的取舍

    千次阅读 2017-11-24 11:15:19
    敏捷开发中文档的取舍 先说需求文档,分为两部分,一方面是框架性的需求文档,对功能、交互方式、出错或边界情况的表现进行总体描述,这种文档需要过于细致,因为产品经理组织语言写文档,开发读文档,理解文档都...
  • 敏捷误区:敏捷并不意味着不需要文档敏捷的过程中,会有一种叫做产品需要设计文档的东东,简称PRD。最近在一次公司组织的内部培训会上,老师提供了一份PRD文档的模板,个人觉得这个PRD模板比较轻量,现在分享给...
  • 敏捷开发之设计文档

    2019-04-28 00:45:51
    对于设计文档的一点体会就是,明确需求、...在产品研发过程中经常需要编写很多文档,例如:需求文档、设计文档、API文档、验收文档等等。团队成员要花费很多精力去维护众多的文档,甚至有“兄弟,我替你写代码,你替...
  • 软件开发模式之敏捷开发(scrum)

    万次阅读 多人点赞 2018-08-08 19:25:59
    这几年关于敏捷开发在互联网企业中越来越广泛被使用到,运用的比较多的当属scrum敏捷开发和xp敏捷开发,人人都在谈论敏捷开发。那什么才是敏捷开发呢? 目录 什么是敏捷开发? 传统的开发模式和敏捷开发模式的...
  • 敏捷开发流程总结

    万次阅读 多人点赞 2010-07-20 15:36:00
     敏捷开发宣言—— 个体和交互 胜过 过程和工具 可以工作的软件 胜过 面面俱到的文档 客户合作 胜过 合同谈判 响应变化 胜过 遵循计划 虽然右项也有价值,但是我们认为左项...
  • 敏捷开发中如何维护文档

    千次阅读 2012-08-09 01:26:42
    软件项目中有很多种文档,包括需求文档、设计文档、API文档、缺陷报告、进度报告、移交文档、验收文档等等。 ...第二条敏捷宣言是"可工作的软件胜于详尽的文档",据此很多人想当然认为敏捷开发
  • 关于敏捷开发和CMMI的管理大家都各有心得,我就不在对各自具体管理做阐述了,紧紧针对文档裁剪说的看法,首先敏捷开发强调的核心的东西是交流,但对于当今的项目开发来说,个人交流恰恰是个难点,做开发的基本上都是...
  • 我们比较熟知的软件项目管理方法是瀑布。其基本流程是需求-> 设计->...国外的软件先行者们针对瀑布开发中暴露出来的问题进行了一系列的探索、思考和总结,提出了Agile Dev的概念,中文翻译为...
  • 背景需求文档解析成本太高。RD解析一遍,QA解析一遍。 我们的产品需求是用户真正需要的吗? 需求文档!=记录产品需求 应该代表用户需求。
  • 敏捷开发和详细设计

    千次阅读 2013-03-28 10:23:57
    的软件周期来进行,随着敏捷开发方法和敏捷开发工具和技巧的发展,软件过程中的 一些步骤被新的开发颠覆甚至忽略。 模块耦合度低的项目,开发人员往往在概要设计、项目结构建立之后,就拿着需求文档在做各自的子...
  • 敏捷开发实践(2)-要不要文档

    千次阅读 热门讨论 2014-03-06 09:57:04
    背景  自从我们使用scrum进行项目开发后,出现了这样那样的问题,有些是因为我们对scrum的理解不...我说的不一定正确,只是描述问题,然后说说我对问题的看法,采取的解决方案,希望使用敏捷开发的大牛提供宝贵意见。
  • 敏捷开发实践(一)--谈谈我对敏捷开发的理解

    万次阅读 热门讨论 2015-05-31 09:58:51
    随着敏捷开发越来越流行,人人都在谈敏捷,人人也都在学习scrum等敏捷开发方法。。。当然,自己也是敏捷开发的实施者和受益者。
  • 敏捷开发 vs 传统模式

    万次阅读 2015-05-28 22:41:00
    说起敏捷开发,并不是因为敏捷而敏捷。这几年的敏捷开发已经被很多敏捷咨询服务商神话了,这个东西并不是神器,实施了就可以解决所有软件公司的问题,而是要结合自己公司的特点和问题摸索出适合自己的一套模式。 ...
  • ios敏捷开发的理解

    2019-03-13 14:37:56
    一,根据以下几个问题来谈谈敏捷开发 1.什么是敏捷开发? 2.为什么使用敏捷开发? 3.如实使用敏捷开发? 4.采用敏捷开发的产品效果? 二.什么是敏捷开发敏捷开发是一种价值和原则,指导我们更加高效的...
1 2 3 4 5 ... 20
收藏数 44,441
精华内容 17,776
关键字:

敏捷开发需要的文档