- 1. 禅道介绍
- 1.1 关于禅道项目管理软件
- 1.2 如何获得支持
- 1.3 各版本功能差异
- 1.4 关注我们
- 2. 安装禅道
- 2.1. 环境搭建
- 2.1.1 搭建Ubuntu环境安装禅道
- 2.1.2 搭建Centos环境安装禅道
- 2.1.3 安装PHP的ioncube扩展
- 2.2. 安装禅道新版本
- 2.2.1 选择适合您的安装方法
- 2.2.2 新版本禅道的安装升级
- 2.2.3 Windows一键安装包(新版)
- 2.2.4 Windows一键安装包(旧版)
- 2.2.5 linux用一键安装包(推荐)
- 2.2.6 使用源码包安装(各系统通用)
- 2.2.7 使用源码包安装(MAC系统)
- 2.2.8 基于禅道当前的一键安装包(Windows和Linux)如何源码安装旗舰版禅道
- 2.2.9 渠成命令行安装禅道
- 2.2.10 Docker和Kubernetes方式部署禅道
- 2.3. 安装12开源版
- 2.3.1 选择适合您的安装方法
- 2.3.2 使用云禅道在线项目管理服务
- 2.3.3 (推荐)windows用一键安装包安装
- 2.3.4 (推荐)Linux用一键安装包
- 2.3.5 linux下用lampp集成包安装
- 2.3.6 使用源码包安装(MAC系统)
- 2.3.7 MAC下用XAMPP安装禅道
- 2.3.8 MAC下用XAMPP-VM安装禅道
- 2.3.9 使用源码包安装(各系统通用)
- 2.3.10 宝塔面板安装禅道
- 2.3.11 华芸NAS在线安装
- 2.3.12 Centos7.4系统下安装httpd,mariadb,php7.2环境运行禅道
- 2.3.13 Centos8系统下安装httpd,mariadb,php7.2环境运行禅道
- 2.3.14 安装ioncube扩展
- 2.3.15 安装swoole扩展
- 2.3.16 Docker方式部署禅道
- 2.4. 安装12企业版
- 2.4.1 禅道企业版安装包安装方式(各系统通用)
- 2.4.2 (推荐)Windows一键安装包安装
- 2.4.3 (推荐)Linux一键安装包安装
- 2.4.4 centos 7.x 源码安装禅道企业版
- 2.5 安装PHP的LDAP扩展
- 2.6 在线安装云禅道
- 2.7 安装 APCu扩展
- 2.8 安装DuckDB引擎
- 2.1. 环境搭建
- 3. 升级禅道
- 3.1. 升级12开源版
- 3.1.1 选择和自己环境对应的升级方式
- 3.1.2 通过源代码方式升级(通用)
- 3.1.3 windows一键安装包的升级
- 3.1.4 linux一键安装包升级
- 3.2. 升级12企业版
- 3.3. 升级禅道新版本
- 3.3.1 选择和自己环境对应的升级方式
- 3.3.2 通过源代码方式升级(通用)
- 3.3.3 windows一键安装包的升级
- 3.3.4 linux一键安装包升级
- 3.3.5 docker安装禅道-升级禅道
- 3.3.6 旧版Docker镜像升级说明
- 3.3.7 通过Roadrunner管理定时任务
- 3.4 如何安装ioncube扩展
- 3.1. 升级12开源版
- 4. 维护配置
- 4.1. 维护禅道
- 4.1.1 初始化管理脚本
- 4.1.2 备份禅道
- 4.1.3 恢复删除的资源
- 4.1.4 如何更新燃尽图
- 4.1.5 一键安装包如何实现mysql异机连接
- 4.1.6 linux一键安装包配置https
- 4.1.7 禅道一键安装包迁移/更新禅道一键安装包
- 4.2. 配置禅道
- 4.2.1 设置是否允许匿名访问
- 4.2.2 如何配置email发信
- 4.2.3 如何成为超级管理员
- 4.2.4 配置禅道系统为静态访问
- 4.2.5 去掉禅道访问地址中的zentao
- 4.2.6 linux一键安装包去掉禅道访问地址中的zentao
- 4.2.7 集成禅道和svn
- 4.2.8 集成禅道和git
- 4.2.9 在第三方应用中集成禅道
- 4.2.10 第三方应用配置免密登录禅道
- 4.2.11 第三方应用集成禅道客户端进行消息通知
- 4.2.12 集成webhook
- 4.2.13 集成ZDOO
- 4.2.14 客户端集成
- 4.2.15 禅道的翻译功能
- 4.2.16 浏览器通知的设置
- 4.2.17 集成钉钉工作消息通知
- 4.2.18 集成企业微信应用消息通知
- 4.2.19 集成飞书群机器人
- 4.2.20 集成飞书消息通知
- 4.2.21 集成版本库、集成Jenkins,并进行构建
- 4.2.22 解决一键安装包密码口令弱的问题
- 4.3. 性能优化
- 4.1. 维护禅道
- 5. 快速入门
- 5.1. 12版本快速入门
- 5.1.1 禅道使用的基本流程和产品、研发、测试之间的三权分立
- 5.1.2 禅道的新手教程
- 5.1.3 创建第一个产品
- 5.1.4 添加第一个需求
- 5.1.5 开始第一个项目
- 5.1.6 确定项目要完成的需求列表
- 5.1.7 为需求分解任务
- 5.1.8 提交bug
- 5.1.9 禅道的自定义功能
- 5.1.10 文档管理
- 5.1.11 如何排查产品、项目是否有访问权限
- 5.1.12 年度总结,工作内容统计一览表说明
- 5.2. 12版创建分组和用户
- 5.2.1 建立部门结构
- 5.2.2 添加一个用户帐号
- 5.2.3 批量维护帐号
- 5.2.4 设置分组,建立权限体系
- 5.3. 12版本最简使用
- 5.3.1 使用禅道来进行项目任务管理
- 5.3.2 只使用禅道来做bug管理
- 5.3.3 只使用禅道来进行产品管理
- 5.3.4 个人使用禅道来做事务跟踪管理
- 5.4. 12版本基本使用
- 5.4.1 敏捷开发及scrum简介
- 5.4.2 禅道和scrum的对应关系
- 5.4.3 视频教程:第一个演示项目
- 5.4.4 维护联系人
- 5.4.5 导入excel、csv参考文档
- 5.4.6 工作方式的切换
- 5.4.7 操作获取积分功能
- 5.4.8 自定义必填项功能
- 5.5. 12版本进阶使用
- 5.5.1. 使用流程
- 5.5.1.1 禅道使用流程图解
- 5.5.2. 个人管理
- 5.5.2.1 使用待办进行个人事务管理
- 5.5.2.2 关注需要自己处理的任务、需求、bug
- 5.5.2.3 通过我的档案查看或者修改个人信息
- 5.5.2.4 视频教程:禅道使用之个人篇
- 5.5.3. 产品经理篇
- 5.5.3.1 维护产品
- 5.5.3.2 维护产品线
- 5.5.3.3 创建和评审需求
- 5.5.3.4 变更和评审需求
- 5.5.3.5 需求的状态和研发阶段
- 5.5.3.6 需求的注意事项
- 5.5.3.7 维护产品模块
- 5.5.3.8 建立发布计划
- 5.5.3.9 建立发布
- 5.5.3.10 路线图
- 5.5.3.11 文档管理
- 5.5.3.12 主持产品会议
- 5.5.3.13 参与项目管理、演示和总结
- 5.5.3.14 需求的基本统计报表
- 5.5.3.15 视频教程:禅道使用之产品经理篇
- 5.5.4. 项目经理篇
- 5.5.4.1 建立项目
- 5.5.4.2 组建项目团队
- 5.5.4.3 确定项目要完成的需求列表
- 5.5.4.4 组织进行任务分解
- 5.5.4.5 召开每天的站立会议
- 5.5.4.6 通过燃尽图了解项目的进展
- 5.5.4.7 通过各种列表的各种功能了解项目进展
- 5.5.4.8 召开演示会议和总结会议
- 5.5.4.9 项目任务基本的报表统计
- 5.5.4.10 视频教程:禅道使用之项目经理篇
- 5.5.5. 开发团队篇
- 5.5.5.1 参加项目计划会议,分解任务
- 5.5.5.2 领取任务,并每天更新任务
- 5.5.5.3 通过看板和树状图查看任务
- 5.5.5.4 创建版本
- 5.5.5.5 申请测试
- 5.5.5.6 解决bug
- 5.5.5.7 文档管理
- 5.5.5.8 确认bug
- 5.5.5.9 视频教程:禅道使用之开发团队篇
- 5.5.6. 测试团队篇
- 5.5.6.1 维护bug视图模块
- 5.5.6.2 提交bug
- 5.5.6.3 验证bug,关闭
- 5.5.6.4 激活bug
- 5.5.6.5 找到自己需要的bug
- 5.5.6.6 维护测试用例视图
- 5.5.6.7 创建测试用例
- 5.5.6.8 测试套件、报告和公共用例库的维护
- 5.5.6.9 管理测试版本
- 5.5.6.10 执行用例,提交Bug
- 5.5.6.11 查看报表统计
- 5.5.6.12 视频教程:禅道使用之测试团队篇
- 5.5.1. 使用流程
- 5.6. 12版本企业版使用
- 5.6.1 开源版功能
- 5.6.2 添加用户和权限维护
- 5.6.3 甘特图功能简介
- 5.6.4 工作日志管理功能简介
- 5.6.5 代码库(SVN GIT)及代码评审
- 5.6.6 日历功能简介
- 5.6.7 Excel导入导出功能简介
- 5.6.8 短信通知功能简介
- 5.6.9 运维管理
- 5.6.10 导出为Word功能简介
- 5.6.11 水晶报表(自定义报表)功能简介
- 5.6.12 LDAP用户验证功能简介
- 5.6.13 反馈管理
- 5.6.14 统计视图功能简介
- 5.6.15 文档管理
- 5.6.16 报表导出功能简介
- 5.6.17. 办公管理
- 5.6.18. 工作流
- 5.6.18.1 工作流内置流程
- 5.6.18.2 工作流功能简介
- 5.6.18.3 自定义内置工作流
- 5.6.18.4 新增工作流示例
- 5.6.18.5 工作流 JS、CSS 使用说明
- 5.6.19 视频及PPT资料
- 5.7. 新版本快速入门
- 5.7.1 15后新版本禅道的新增功能
- 5.7.2 15后新版本禅道的界面变化
- 5.7.3 15后新版本禅道的最简使用
- 5.1. 12版本快速入门
- 6. 按照角色使用
- 6.1. 管理员
- 6.1.1 维护组织部门
- 6.1.2 维护用户
- 6.1.3 维护权限
- 6.1.4. 办公管理(企业版)
- 6.1.5. 工作流(企业版)
- 6.1.5.1 内置工作流(企业版)
- 6.1.6 短信通知(企业版)
- 6.1.7. 运维管理(企业版)
- 6.1.7.1 ZAgent的使用(企业版)
- 6.1.7.2 虚拟机的使用
- 6.1.8 LDAP用户验证(企业版)
- 6.2. 项目集负责人
- 6.3. 产品经理
- 6.4. 项目经理
- 6.4.1 维护项目和执行
- 6.4.2 维护团队
- 6.4.3 关联需求
- 6.4.4 分解任务
- 6.4.5 跟踪进度
- 6.4.6 甘特图(企业版)
- 6.4.7 代码评审(企业版)
- 6.4.8 瀑布项目的使用
- 6.4.9. 瀑布项目特有功能(旗舰版)
- 6.4.9.1 维护项目的计划、阶段(旗舰版)
- 6.4.9.2 项目设计、矩阵(旗舰版)
- 6.4.9.3 项目评审、配置(旗舰版)
- 6.4.9.4 项目报告、挣值管理(旗舰版)
- 6.4.9.5 项目调研、估算(旗舰版)
- 6.4.9.6 项目问题、风险、机会(旗舰版)
- 6.4.9.7 项目过程、度量、QA(旗舰版)
- 6.4.9.8 项目培训、会议(旗舰版)
- 6.4.10 看板项目的使用
- 6.4.11 融合敏捷项目
- 6.4.12 融合瀑布项目
- 6.4.13 文档管理(企业版)
- 6.4.14 Excel 导入导出(企业版)
- 6.4.15 Word 导出(企业版)
- 6.4.16 统计(企业版)
- 6.4.17 报表导出(企业版)
- 6.4.18 资产库管理
- 6.5. 研发人员
- 6.5.1 参加产品计划会议,分解任务
- 6.5.2 领取任务,并每天更新任务
- 6.5.3 创建版本,提交测试
- 6.5.4 确认Bug,解决Bug
- 6.5.5 执行的综合、需求、Bug、任务看板
- 6.6. 测试人员
- 6.1. 管理员
- 7. 功能介绍
- 7.1. 核心管理结构
- 7.1.1 项目集(Program)
- 7.1.2 项目(Project)
- 7.1.3 产品(Product)
- 7.1.4 执行(Execution)
- 7.1.5 管理模型
- 7.2. 地盘
- 7.3. 项目集
- 7.4. 产品
- 7.4.1 创建产品
- 7.4.2 维护模块
- 7.4.3 产品多分支/平台管理
- 7.4.4 维护计划
- 7.4.5 维护需求
- 7.4.6 需求的评审
- 7.4.7 创建发布
- 7.4.8 跟踪进度
- 7.4.9 业务需求&需求多层级
- 7.5. 项目
- 7.5.1. 项目通用功能
- 7.5.1.1 项目的基本设置
- 7.5.1.2 维护项目的执行
- 7.5.1.3 维护项目的需求
- 7.5.1.4 维护项目的Bug、用例、测试单、测试报告
- 7.5.1.5 维护项目的文档
- 7.5.1.6 维护项目的版本、发布
- 7.5.2 看板项目
- 7.5.3. 瀑布项目特有功能(企业版与旗舰版)
- 7.5.3.1 维护项目的计划、阶段
- 7.5.3.2 项目设计、矩阵(矩阵为旗舰版)
- 7.5.3.3 项目评审、配置(旗舰版)
- 7.5.3.4 项目报告、挣值管理(旗舰版)
- 7.5.3.5 项目调研、估算(旗舰版)
- 7.5.3.6 项目问题、风险、机会(旗舰版)
- 7.5.3.7 项目过程、度量、QA(旗舰版)
- 7.5.3.8 项目培训、会议(旗舰版)
- 7.5.4 融合敏捷项目
- 7.5.5 融合瀑布项目
- 7.5.6 项目资源日历(插件)
- 7.5.1. 项目通用功能
- 7.6. 执行
- 7.6.1 参加产品计划会议,分解任务
- 7.6.2 领取任务,并每天更新任务
- 7.6.3 创建版本,提交测试
- 7.6.4 确认Bug,解决Bug
- 7.6.5 执行的综合、需求、Bug、任务看板
- 7.7. 测试
- 7.8. 自动化测试
- 7.9 DevOps(解决方案)
- 7.10. DevOps(旧版)
- 7.10.1. DevOps 功能
- 7.10.1.1 Git/SVN版本库管理和查看代码
- 7.10.1.2. 集成GitLab
- 7.10.1.2.1 绑定用户,关联issue,进行构建
- 7.10.1.2.2 合并请求
- 7.10.1.2.3 禅道中GitLab的权限
- 7.10.1.3 集成Jenkins,进行构建
- 7.10.1.4 集成SonarQube
- 7.10.1. DevOps 功能
- 7.11. 看板
- 7.11.1 通用看板功能
- 7.12. 资产库(旗舰版)
- 7.12.1 资产库管理(旗舰版)
- 7.13. 文档
- 7.14. BI
- 7.14.1 维度(企业版8.4+)
- 7.14.2 大屏(企业版8.4+)
- 7.14.3. 大屏设计器
- 7.14.3.1 大屏设计器界面布局
- 7.14.3.2 大屏设计器引用图表
- 7.14.3.3 大屏设计器引用透视表
- 7.14.4 透视表(企业版8.4+)
- 7.14.5 透视表(企业版10.2+)
- 7.14.6 图表(企业版8.4+)
- 7.14.7 数据表(企业版8.4+)
- 7.14.8. 度量项
- 7.14.8.1 查看度量项
- 7.14.8.2 创建度量项
- 7.14.8.3 度量项编码开发操作手册
- 7.14.9 统计(旧版)
- 7.14.10 报表导出(旧版)
- 7.14.11 自定义报表(旧版)
- 7.14.12 可视化(旧版)
- 7.14.13. SQL构建器
- 7.14.13.1 联表查询常用方式:左连接
- 7.14.13.2 SQL构建器使用手册
- 7.15. AI
- 7.15.1 AI小程序简介
- 7.15.2 创建与设计AI小程序(企业版)
- 7.15.3 调试AI小程序(企业版)
- 7.15.4 发布与禁用小程序
- 7.15.5 前台小程序的应用
- 7.15.6 AI小程序的导入导出
- 7.15.7 管理AI小程序权限
- 7.16. 组织
- 7.16.1 团队成员和工作信息
- 7.16.2 人力资源日历(需安装插件)
- 7.16.3 组织动态
- 7.16.4 公司信息
- 7.17. 办公(企业版)
- 7.18. 反馈(企业版)
- 7.19. 学堂(企业版)
- 7.19.1 学堂的课程和后台(企业版)
- 7.19.2 实践库(企业版)
- 7.20. 工作流(企业版)
- 7.20.1 内置工作流(企业版)
- 7.21. 后台设置
- 7.21.1 首页
- 7.21.2. 系统设置
- 7.21.2.1 模式、备份、回收站
- 7.21.2.2 聊天
- 7.21.2.3 授权、安全、定时、时区、重建索引、表引擎
- 7.21.2.4 LDAP(企业版)
- 7.21.3 功能开关(超级管理员)
- 7.21.4. 人员管理
- 7.21.5 模型配置
- 7.21.6. 功能配置
- 7.21.6.1 地盘、产品、执行、测试、看板、文档、反馈
- 7.21.6.2 审批、度量、用户、会议室
- 7.21.6.3 审批流程(旗舰版)
- 7.21.6.4 审批流程(旗舰版5.1)
- 7.21.7 文档模板(旗舰版)
- 7.21.8. 通知设置
- 7.21.9 插件管理
- 7.21.10 二次开发
- 7.21.11 数据导入(管理员)
- 7.21.12. 权限维护和控制
- 7.21.12.1 项目集的权限维护和访问控制
- 7.21.12.2 产品的权限维护和访问控制
- 7.21.12.3 项目的权限维护和访问控制
- 7.21.12.4 执行的权限维护和访问控制
- 7.21.12.5 项目和执行的访问控制和数据关系
- 7.21.13. AI配置
- 7.21.14. DevOps设置
- 7.22. 客户端增强版会议SRS
- 7.22.1. 音视频会议配置
- 7.22.1.1 安装音视频服务端
- 7.22.1.2 安装SRS音视频服务端
- 7.22.1.3 开启和配置音视频功能
- 7.22.2. 发起会议
- 7.22.2.1 一对一会话中发起音视频会议
- 7.22.2.2 群组会话中发起音视频会议
- 7.22.2.3 独立发起音视频会议入口
- 7.22.3. 加入会议
- 7.22.3.1 分享音视频会议到会话
- 7.22.3.2 通过会议的ID加入会议
- 7.22.4. 预约会议
- 7.22.4.1 预约会议
- 7.22.5. 会议应用
- 7.22.5.1 音视频会议应用
- 7.22.1. 音视频会议配置
- 7.23. 客户端增强版会议Jitsi
- 7.1. 核心管理结构
- 8. 其他相关
接口空间 分享链接
本篇目录
可以在接口空间中管理接口库和文档、数据结构、版本管理及发布接口。
接下来我们来具体介绍接口空间如何使用。
一、分配权限
首先需要分配接口空间的相关操作权限。
到后台--人员管理--权限里的接口管理部分,分配对应的权限即可,权限分配可以灵活按照实际工作需要来分配。
二、维护接口库
1、创建接口库
点击文档--接口空间--创建库的按钮,可以创建接口库。
在创建库的弹窗中,可设置请求基础路经、接口库的访问控制。支持创建独立接口库、产品接口库以及项目接口库。
选择私有权限后,可设置白名单用户。
接口库创建成功后,可以在左上角的接口库下拉组件里查看到。
创建接口库成功后,我们就可以对接口库进行目录、版本管理、编辑和删除接口库操作。
2、查看某产品或某项目下的接口库或文档
可选择产品或项目,查看其下的接口库和文档。
3、维护接口库目录
鼠标悬浮到某接口库上,点击右侧出现的更多按钮,可添加目录、编辑库和删除库。
鼠标悬浮到某接口库下文档时,点击右侧出现的更多按钮,可添加同级目录、添加子目录、编辑目录和删除目录。
编辑接口库:点击下拉菜单中的编辑接口库和编辑目录按钮。
删除接口库:点击下拉菜单中的删除接口库和删除目录按钮。
删除接口库和删除目录会出现二次确认的弹窗
三、维护接口
维护好接口库的目录后,我们就可以添加接口库文档了。
1、创建接口
点击文档--接口空间--创建接口的按钮,可以创建接口文档。
当接口库下没有接口文档时,也可在页面中点击创建接口按钮。
在创建接口页面中,可填写内容如下:
所属接口库:默认不可更改
目录:可在下拉菜单中选择所属接口库的目录
请求路径:目前支持 HTTP、HTTPS、WS和WSS , GET、POST、PUT、DELETE、PACTH、OPTIONS、HEAD
请求格式:application/json , application/x-www-form-urluncoded ,multipart/form-data
开发状态:开发完成、开发中、不显示
负责人:负责该接口的人员
请求头:接口的请求头字段
请求参数:接口的请求参数字段
请求体:有4种类型:FormData,JSON,Array,Object
选择了类型后,可以根据类型填写字段名、字段类型、是否必填、描述。
以及给字段添加子字段,对字段、子字段进行添加和删除操作。
请求示例:根据请求体,给出一个请求示例。
请求响应:填写该接口的响应字段、字段类型、是否必填、描述、添加子字段等操作。
响应示例:根据接口的请求响应字段,编写一个响应示例。
描述:对接口的简要介绍。
填写完接口的信息,点击保存,即可在接口列表查看到添加成功的接口。
可以查看接口的开发状态,请求路径。
2、编辑接口
接口列表详情中,点击右上角的编辑按钮,进入编辑接口页面。
编辑接口页面:
需要注意的是,编辑接口不能更改所属的接口库。
3、全屏和删除接口
点击全屏按钮,可以全屏查看接口文档。
点击删除按钮,可以删除接口,需二次确认。
四、发布接口
点击发布接口按钮,进入发布接口的版本创建页面,可以发布接口。
创建接口发布版本:
发布接口成功后,可以切换版本来查看接口文档。
五、版本管理
点击版本管理按钮,可以对接口文档进行版本管理,查看已发布的版本和删除不需要的版本。
六、维护数据结构
点击数据结构按钮,进入数据结构列表页面。
在数据结构列表页,可以创建数据结构。
在创建数据结构页面,填写数据结构的名称,类型和字段和描述即可。
创建成功的数据结构在数据结构列表里显示,可查看、编辑和删除。
七、导出文档
点击页面右上方的导出按钮,可以选择导出范围是「列表中接口文档」或者「未关联产品和项目的所有接口文档」,文档类型为word,编码为UTF-8,导出格式仅支持导出为合并为一个文档。