禅道项目的帮助手册全部.docx

1、禅道项目的帮助手册全部禅道的帮助手册V4.0.1第一章：禅道介绍1.1什么是禅道(ZenTao)？禅道是第一款国产的开源项目管理软件。它集产品管理、项目管理、质量管理、文档管理、组织管理和事务管理于一体，是一款专业的研发项目管理软件，完整地覆盖了项目管理的核心流程。注重实效的管理思想，合理的软件架构，简洁高效的操作，优雅的代码实现，灵活的扩展机制，强大而易用的api调用机制，多语言支持，多风格支持，搜索功能，统计功能这一切，您通过禅道，都可以拥有！禅道在手，项目无忧！1.2为什么用“禅道(ZenTao)”这个名字？禅和道是中国文化中极具代表意义的两个字，是中国传统文化的结晶。我们之所以选用“禅

2、道”作为我们软件的名字，是希望通过这两个字来传达我们对管理的理解和思考。我们希望通过禅道来进行的管理，可以摒弃繁文缛节，摒弃官本位的畸形，还原事情的本质！英文里面的禅为Zen，道为Tao，所以我们软件的英文名字为zentao，我们的官方网站为，记住这个单词吧！1.3禅道的设计理念禅道项目管理软件的主要管理思想基于国际流行的敏捷项目管理方式Scrum。scrum是一种注重实效的敏捷项目管理方式，但众所周知，它只规定了核心的管理框架，但具体的细节还需要团队自行扩充。禅道在遵循其管理方式基础上，又融入了国内研发现状的很多需求，比如bug管理，测试用例管理，发布管理，文档管理等。因此禅道不仅仅是一款s

3、crum敏捷项目管理工具，更是一款完备的项目管理软件。基于scrum，又不局限于scrum。禅道还首次创造性的将产品、项目、测试这三者的概念明确分开，产品人员、开发团队、测试人员，这三者分立，互相配合，又互相制约，通过需求、任务、bug来进行交相互动，最终通过项目拿到合格的产品。14选择禅道的八大理由：1 开源的软件，保证了您使用的放心和灵活。2 先进的管理思想，让您在竞争中拔得头筹。3 完备的管理功能，无需再整合其他多个系统。4 国产软件，中文支持，操作习惯更符合国人。5 灵活的扩展机制，可以保证您不局限于禅道自身的功能。6 日趋完善的社区机制，可以获得及时的技术支持和帮助，保证您无后顾之忧

4、。7 几乎为零的投入，禅道作为开源软件，其投入几乎为零，相比动辄十几万的商业软件，您选择禅道没有任何风险。8开发团队已经公司化运作，保证软件的持久发展。我们从04年从事开源软件开发以来，已经坚持了六年。 15禅道的功能列表：1 产品管理：包括产品、需求、计划、发布、路线图等功能。2 项目管理：包括项目、任务、团队、build、燃尽图等功能。3 质量管理：包括bug、测试用例、测试任务、测试结果等功能。4 文档管理：包括产品文档库、项目文档库、自定义文档库等功能。5 事务管理：包括todo管理，我的任务、我的Bug、我的需求、我的项目等个人事务管理功能。6组织管理：包括部门、用户、分组、权限等功

5、能。7 统计功能：丰富的统计表。8 搜索功能：强大的搜索，帮助您找到相应的数据。9 灵活的扩展机制，几乎可以对禅道的任何地方进行扩展。10 强大的api机制，方便与其他系统集成。第二章：禅道安装从4.0.beta2版本开始，我们重构了windows一键安装包的控制面板程序，本篇文章将讲述如何使用该控制面板来启动禅道环境。注：360软件会经常误报，建议使用金山毒霸，或者安装禅道之前，先暂停360软件。2.1安装1 在我们的站点下载最新的windows集成运行环境(.exe结尾)。2 双击解压缩到某一个分区的根目录，比如c:xampp，或者d:xampp， 必须是根目录。3 进入xampp文件夹，

6、双击star.bat启动控制面板程序，界面如下：2.2启动并访问禅道1 启动控制面板之后，点击“启动禅道”按钮，系统会自动启动禅道所需要的apache和mysql服务。2 启动成功之后，点击“访问禅道”，即可打开禅道环境的首页。5秒钟之后，页面会自动跳转到禅道的页面。2.3相关密码1 禅道项目管理软件的登录帐号是admin,密码是123456，请登录之后尽快修改自己的密码。2 mysql数据库的管理员帐号是root，密码为空。(如果您修改了root帐号的密码，请一定记得修改zentao/config/my.php里面的数据库密码)3数据库管理是使用的phpmyadmin程序，基于安全方面的考虑

7、，只能在禅道所在的机器上面访问，从其他机器访问会被禁止。2.4关于该环境1 禅道的访问路径为http:/禅道机器的ip地址:端口号/zentao/，其中ip地址换成禅道机器所在的ip地址，端口号如果不是80的话，换成实际的端口号。2 该控制面板会自动安装apache和mysql为服务，服务名分别是apachezt, mysqlzt。3 该环境是从xampp版本精简而来。2.5如果控制面板失败控制面板是我们全新写的程序，难免会出现一些差错，如果无法通过控制面板启动禅道程序，我们还提供了命令行的控制脚本来启动禅道：1 切换到xamppservice目录2双击install.bat这个脚本，系统会自

8、动尝试安装apache和mysql为服务，并启动。3安装成功之后，在这个目录下面会有port.apache和port.mysql来记录apache和mysql的端口号，如果您想更改端口，可以将这两个文件删掉，重新运行install.bat脚本。第三章：创建分组和用户3.1建立部门结构禅道安装成功之后，管理员的第一件要做的事情就是设置部门结构。1. 以管理员身份登录。 2. 进入组织视图 3. 选择部门维护。 4. 在部门维护页面，维护公司的组织结构即可。 3.2添加一个帐号部门创建之后，下一步的操作就是往系统中添加用户。步骤如下：1. 进组织视图 2. 选择用户列表 3. 然后选择“添加用户”

9、，即可进入添加用户页面。 4. 用户添加完之后，即可将其关联到某一个分组中。 注意点：1. 从4.0版本开始增加了角色字段，在添加帐号的时候可以选择对应的角色。角色会影响到指派列表的顺序，比如创建bug的时候，默认会把研发角色的同学放在前面。角色还会影响到我的地盘里面内容的排列顺序。比如产品经理角色的人登录之后，我的地盘首先会显示我的需求，而研发的同学登录之后，会看到我的任务。 2. 用户的权限都是通过分组来获得的，因此为用户指定了一个角色之后，还需要将其关联到一个分组中。 3. 其中源代码提交帐号是subversion或者其他源代码管理系统中对应的用户，如果没有启用subversion集成功

10、能，可以留空。 3.3批量维护帐号从4.0版本开始，我们提供了批量添加帐号的功能，可以很方便的批量创建帐号。1. 使用管理员登录禅道系统，进入“组织”页面。 2. 选择“用户列表”，然后选择右侧的“批量添加” 除了批量添加用户，还可以在用户列表页面选择用户，进行批量编辑。3.4设置分组，建立权限体系在禅道中，用户权限都是通过分组来获得的。所以在完成部门结构划分之后，就应该建立用户分组，并为其分配权限。有的朋友可能会问，用户分组和部门结构有什么区别？我们来解释下这个问题。部门结构是公司从组织角度来讲的一个划分，它决定了公司内部人员的上下级汇报关系。而禅道里面的用户分组则主要用来区分用户权限。二者

11、之间并没有必然的关系。比如用户A属于产品部，用户B属于研发部，但他们都有提交bug的权限。3.4.1创建分组1. 使用管理员登录禅道，进入组织视图。 2. 选择权限分组，进入分组的列表页面。3. 点击新增，即可创建分组。 4. 在这个分组列表页面，还可以对某一个分组进行权限的维护、成员维护、或者复制。 3.4.2维护权限1. 管理员身份登录 2. 进入组织试图 3. 点击”权限分组“，进入权限分组列表页面。 4. 选择某一个分组，点击“权限维护”，即可维护该分组的权限。5. 点击某一个模块名后面的复选框，可以全选该模块下面的所有权限，或者全部取消选择。还可以查看某一个版本新增的权限列表。 3.

12、4.3维护成员1. 管理员身份登录 2. 进入组织视图中的权限分组。 3. 点击”成员维护“，进入用户维护页面。 3.4.4其他快捷的操作除了上面所讲的按照维护权限和维护帐号操作外，还可以通过复制或者“按照模块来维护”权限。复制操作很简单，选择某一个分组，然后点击后面的复制操作，即可。下面我们来讲下按照模块来分配权限。1. 管理员身份登录 2. 进入组织视图中的权限分组。 3. 点击页面下方的“按模块维护”按钮。 3.5基础使用3.5.1禅道使用的基本流程和产品、研发、测试之间的三权分立禅道管理软件中，最核心的三种角色：产品经理、研发团队和测试团队，这三者之间通过需求进行协作，实现了研发管理中

13、的三权分立。其中产品经理整理需求，研发团队实现任务，测试团队则保障质量，其三者的关系如下图：基本流程如下：1. 产品经理创建产品2. 产品经理创建需求3. 项目经理创建项目4. 项目经理确定项目要做的需求5. 项目经理分解任务，指派到人。6. 测试人员测试，提交bug。3.5.2敏捷开发及scrum简介在正式讲述禅道的基本使用流程之前，先让我们来了解下敏捷开发和scrum。因为禅道的设计理念基础是基于scrum的，因此了解scrum的基本概念有助于您了解和使用禅道。3.5.2.1敏捷开发我们比较熟知的软件项目管理方法是瀑布。其基本流程是需求- 设计-开发-测试。基本假设只要把每一个环节都做正确

14、，那么最终得到的结果也是正确的。瀑布开发有非常成功的案例，比如微软。但从总体来讲，瀑布项目失败率比较高。国外的软件先行者们针对瀑布开发中暴露出来的问题进行了一系列的探索、思考和总结，最终提出了Agile的概念，中文翻译为敏捷开发。敏捷开发有很多种方式，其中scrum是比较流行的一种。3.5.2.2scrum2.1 scrum里面的角色scrum由product owner(产品经理)、scrum master和team(研发团队)组成。 其中product owner负责整理user story(用户故事)，定义其商业价值，对其进行排序，制定发布计划，对产品负责。 scrum master 负

15、责召开各种会议，协调项目，为研发团队服务。 研发团队则由不同技能的成员组成，通过紧密协同，完成每一次迭代的目标，交付产品。 2.2 迭代开发与瀑布不同，scrum将产品的开发分解为若干个小sprint(迭代)，其周期从1周到4周不等，但不会超过4周。参与的团队成员一般是5到9人。每期迭代要完成的user story是固定的。每次迭代会产生一定的交付。2.2 scrum的基本流程scrum的基本流程如上图所示： 产品负责人负责整理user story，形成左侧的product backlog。 发布计划会议：product owner负责讲解user story，对其进行估算和排序，发布计划会议

16、的产出就是制定出这一期迭代要完成的story列表，sprint backlog。 迭代计划会议：项目团队对每一个story进行任务分解，分解的标准是完成该story的所有任务，最终每个任务都有明确的负责人，并完成工时的最初估计。 每日例会：每天scrum master召集站立会议，团队成员回答昨天做了什么今天计划做什么，有什么问题。 演示会议：迭代结束之后，召开演示会议，相关人员都受邀参加，团队负责向大家展示本次迭代取得的成果。期间大家的反馈记录下来，由po整理，形成新的story。 回顾会议：项目团队对本期迭代进行总结，发现不足，制定改进计划，下一次迭代继续改进，已达到持续改进的效果。 3.

17、5.3禅道和scrum的对应关系禅道在设计的时候，基础框架是基于scrum的，同时又补充完善了测试，文档，发布，计划等功能。肯定有同学会问，是不是我使用禅道，就必须是用敏捷。答案当然是否定的，您完全可以使用禅道来进行瀑布式管理，也可以使用的很好。正式基于这一点考虑，我们在设计禅道的时候，都是采用了比较中性的概念，而不是scrum里面特有的概念。下面让我们来看下禅道和scrum的对应关系。3.5.3.1概念的对应scrum禅道备注product产品禅道里面使用了产品的概念。user story需求其实标准的翻译应该为用户故事，不过禅道还是采用了比较中性的概念。sprint项目很多朋友对产品和项目

18、的概念不是很清楚，其实有了这个对应关系就很容易理解了。task任务这两个概念是一致的。team团队burndown chart燃尽图潜在交付物发布3.5.3.2角色的对应scrum禅道备注product owner产品经理禅道使用的还是比较中性的产品经理的概念。scrum master项目经理team团队成员3.5.3.3禅道新增的概念除了scrum基本的概念外，禅道还补充完善了下面概念，以达到对软件生命周期的完整覆盖。 产品发布计划 产品路线图 build bug 测试用例 测试任务 测试结果 文档 todo3.5.4创建第一个产品禅道的设计理念是围绕产品展开的，因此我们首先要做的就是创建一

19、个产品。 产品名称和产品代码是必填项。其中产品代号可以理解为团队内部约定俗称的一个称呼，比如我们禅道的代号是zentao，需要是英文字母和数字的组合。 产品负责人：负责整理需求，对需求进行解释负责，制定发布计划，验收需求。 测试负责人：可以为某一个产品指定测试负责人，这样当创建bug，而不知道由谁进行处理的时候，该产品的测试负责人会成为默认的负责人。 发布负责人：由这个角色负责创建发布。 访问控制：可以设置产品的访问权限，其中默认设置只要有产品视图的访问权限就可以访问。如果这个产品是私有产品，可以将其设置为私有项目，那么就只有项目团队成员才可以访问。或者还可以设置白名单，指定某些分组里面的用户

20、可以访问该产品。3.5.5创建第一个需求我们产品经理可能都习惯了写需求设计文档，或者规格说明书，通过一个非常完整的word文档将某一个产品的需求都定义出来。但在禅道里面，我们提倡按照功能点的方式来写需求。简单来讲，就是将原来需求设计文档中的每一个功能点摘出来，录在禅道里面，作为一个个独立的功能点。如果按照scrum标准走的话，我们可以称之为用户故事(user story)。所谓用户故事，就是来描述一件事情，作为什么用户，希望如何，这样做的目的或者价值何在，这样有用户角色，有行为，也有目的和价值所在，非常方便与团队成员进行沟通。创建需求的步骤如下：1. 使用产品经理角色登录系统。2. 进入产品视

21、图。 3. 在页面右侧，有“新增需求”菜单，点击菜单，出现新增需求的页面。o 需求的标题是必填项。o 所属计划和模块，可以暂时保留为空。o 需求审核那块，我们选上不需要审核，这样新创建的需求状态就是激活的。只有激活状态的需求才能关联到项目中，进行开发。o 需求可以设置抄送给字段，这样需求的变化都可以通过email的形式抄送给相关人员。o 可以设置关键词，这样可以比较方便的通过关键词进行检索。3.5.6开始第一个项目产品经理按照我们前面的操作创建需求之后，下面该项目经理上场了。下面我们一起来看下如何在禅道中开始一个项目。3.5.6.1创建项目1 进入项目视图，点击右侧的”新增项目“链接。2 出现

22、项目添加的页面在这个页面设置项目名称、代号、起止时间、可用工作日、团队名称、项目目标和项目描述等字段。其中关联产品是可以为空的。 和我们前面讲述的最简使用流程有一点区别就是在添加项目的时候，需要关联下产品。可以多选。 项目可以控制它的访问权限，分为默认、私有和自定义白名单三种。3.5.6.2设置团队1 点击保存按钮，会提示项目创建成功，然后可以选择设置团队。2 或者从项目视图中的团队菜单，也可以进行项目的团队管理。在维护项目团队的时候，需要选择都是哪些用户可以参与到这个项目中，同时需要设置这个用户在本项目中的角色（角色可以随便设置，比如风清扬，冬瓜一号等）。可用工作日和可用工时每天需要仔细设置

23、。通常来讲，一个人不可能每天8小时投入，也不可能一星期七天连续投入。3 设置完毕之后，系统会自动计算这个项目总得可用工时。3.5.7确定项目要完成的需求列表迭代开发区别于瀑布式开发就是它将众多的需求分成若干个迭代来完成，每个迭代只完成当下优先级最高的那部分需求。禅道软件中项目关联需求的过程，就是对需求进行排序筛选的过程。下面我们来看下如何关联需求。3.5.7.1关联产品如果在创建项目的时候，已经关联过产品，可以忽略这个步骤。1. 以项目经理身份登录。 2. 进入项目视图。 3. 点击“关联产品”按钮。然后点选该项目相关的产品即可。3.5.7.2关联需求1. 在关联需求的时候，可以按照优先级进行

24、排序。2. 关联的需求状态必须是激活的（评审通过，不能是草稿）3.5.8为需求分解任务需求确定之后，项目中几个关键的因素都有了：周期确定、资源确定、需求确定。下面我们要做的事情就是为每一个需求做wbs任务分解，生成完成这个需求的所有的任务。note:是完成需求的所有任务，这里面包括但不限于设计，开发，测试等。 3.5.8.1访问项目的需求列表页面：在项目的需求列表页面，可以很方便地对某一个需求进行任务分解。 同时还可以查看这个需求已经分解的任务数。3.5.8.2分解任务 这时候创建任务的时候，就可以选择需求了。 我们同时提供了需求查看的链接。 如果需求和任务的标题是一样的，可以通过”同需求“按

25、钮快捷的复制需求的标题。3.5.8.3任务分解的几个注意事项1. 需要将所有的任务都分解出来。这里面包括设计，开发，测试，美工，甚至包括购买机器，部署测试环境等等。2. 任务分解的粒度越小越好，比如几个小时就可以完成。3. 如果一个任务需要多个人负责，继续考虑将其拆分。4. 事务型的事务可以批量指派，比如需要让团队里面的每一个人都写个项目总结，可以选择类型是事务，然后批量指派给团队里面的所有人员。5. 任务的类型请仔细设置，这个会涉及到需求研发阶段的自动计算。后面我们会有讲解。6. 任务的分配最好是自由领取，这样可以最大程度上调动大家的积极性。3.5.9提交bug项目进展到后期主要的工作就是测

26、试。测试人员和开发通过bug进行互动，保证产品的质量。3.5.9.1禅道里面bug的基本处理流程禅道里面缺陷处理的基本流程是：测试提交bug = 开发解决bug = 测试验证bug = 测试关闭bug。如果bug验证没有通过，可以激活：测试提交bug = 开发解决bug = 测试验证bug = 测试激活bug = 开发解决bug = 测试验证 = 测试关闭。还有一个流程就是bug关闭之后，又发生了。测试提交bug = 开发解决bug = 测试验证bug = 测试关闭bug = 测试激活bug = 开发解决bug = 测试验证 = 测试关闭。3.5.9.2提出bug 在创建bug的时候，必填的字

27、段是影响版本，bug标题，重现步骤这些基本的信息。 所属项目，相关产品，需求可以忽略。 创建bug的时候，可以直接指派给某一个人员去处理。如果不清楚的话，可以保留为空。3.5.9.3解决bug当一个bug指派给某一位研发人员之后，他可以来验证解决这个bug。1 通过各种标签和检索条件找到需要自己处理的bug在对bug进行出来之前，需要先要找到需要自己处理的bug。禅道提供了各种各样的检索方式，比如指派给我，可以列出所有需要我处理的bug。2 解决bug研发人员解决bug，选择解决方案，一般来讲有效的解决bug方案是”已解决“。详细的解决方案，我们在后续的文章中会详细加以讲述。3.5.9.4关闭

28、bug当研发人员解决了bug之后，bug会重新指派到bug的创建者头上。这时候测试人员可以来验证这个bug是否已经修复。如果验证通过，则可以关闭该bug。第四章：功能描述4.1产品管理4.1.1维护产品产品管理对于公司来讲，至关重要。只有做出好的产品或者服务出来，才能赢得市场，谋求发展和生存。所以产品经理的这个位子对于公司来讲，是非常关键的，相当于公司的大脑，在决定着公司前进的方向。在禅道里面，产品和项目这两个概念被明确的区分开来。产品是需求方，决定做什么。项目是执行方，解决的是如何做的问题。而测试则是保障方，解决的是正确的做事情的问题。所以在禅道中，所有的一切都是围绕产品展开的。产品是整个项

29、目管理活动的核心。4.1.1.1创建产品1. 用产品经理的角色登录禅道。 2. 进入产品视图，然后点击页面右侧的“新增产品”链接，即可出现新增产品的页面。 3. 如果系统中还没有添加产品，系统也会自动跳转到产品的添加页面。4.1.1.2添加产品时需要注意的地方： 产品代号相当于大家对这个产品的一个隐喻，比如禅道项目管理软件的代码是zentao。 产品负责人负责整理和解释整个产品的需求，制定相应的发布计划。 测试负责人，可以指定默认的测试负责人。这样可以适用于公司人比较多，提交bug不知道该给谁的情况。 发布负责人主要的职责是创建发布。 访问控制，则可以控制访问该产品的人员列表。比如可以将某一个

30、产品设为私有，只有产品添加者、产品负责人、测试负责人、发布负责人以及该产品的项目团队才可以访问。 可以将某一个模块的多个方法同时分配给多个分组。4.1.2创建和评审需求我们产品经理可能都习惯了写需求设计文档，或者规格说明书，通过一个非常完整的word文档将某一个产品的需求都定义出来。但在禅道里面，我们提倡按照功能点的方式来写需求。简单来讲，就是将原来需求设计文档中的每一个功能点摘出来，录在禅道里面，作为一个个独立的功能点。如果按照scrum标准走的话，我们可以称之为用户故事(user story)。所谓用户故事，就是来描述一件事情，作为什么用户，希望如何，这样做的目的或者价值何在，这样有用户角色，有行为，也有目的和价值所在，非常方便与团队成员进行沟通。 4.1.2.1创建需求1. 使用产品经理角色登录系统。2. 进入产品视图。 3. 在页面右侧，有“新增需求”菜单，点击菜单，出现新增需求的页面。o 需求的标题是必填项。o 所属计划和模块，可以暂时保留为空。o 需求审核那块，我们选上不需要审核，这样新创建的需求状态就是激活的。只有激活状态的需求才能关联到项目中，进行开发。o 需求可以设置