redmine使用说明书

一、Redmine简介

1.Redmine 是一个开源的, 基于Web的项目管理和缺陷跟踪工具. 它用日历和甘特图辅助项目及进度可视化显示. 同时它又支持多项目管理. Redmine是一个自由开放源码软件解决方案,它提供集成的项目管理功能, 问题跟踪,并为多个版本控制选项的支持. Redmine是一个有用的Scrum和敏捷的选择. 由于Redmine的设计受到Trac的较大影响,所以它们的软件包有很多相似的特征. Redmine建立在Ruby on Rails的框架之上, 他可以跨平台和数据库.

2.Redmine是一个交流的平台, 所有跟项目有关的内容都可以放进去,需要的人可以随时查看, 而不必挨个找人问.

3.有任何新的想法和发现了新问题都可以随时记录下来, 如果坚持使用,可以彻底解决优秀想法被遗忘的问题.

二、功能视图

1.多项目支持

1.1在一个Redmine平台上管理您的所有项目；

1.2 用户在不同项目中可以是不同的角色；

1.3 项目可设定为公开的(所有人可见)或者内部的(只有项目成员可见) ；

1.4可在项目中激活或者隐藏模块(即: wiki , 版本库, 问题描述, 问题跟踪…)；

2.基于角色的灵活访问控制

定义您自己的角色并快速设置角色的信息和权限.

3.灵活的问题跟踪系统

3.1 定义您自己的问题状态和问题类型；

3.2可以通过web管理界面为每种问题类型和角色设置工作流程.

4.甘特图和日历

根据为问题设定的开始日期和完成日期自动生成甘特图和日历.

5.时间跟踪功能

5.1 在项目级别或者问题级别设定时间；

5.2 根据用户, 问题类型, 类别或者活动生成工作量报表。

6.自定义属性

6.1 可以为问题, 项目和用户添加自定义属性；

6.2 可以使用多种格式: 文本, 日期, 证书, 下拉列表, 复选框；

6.3 自定义属性可以像常规属性那样显示在问题列表中并可以作为过滤器使用.

7.新闻，文档和文件管理

7.1 可以方便快速发布消息, 查看新闻；

7.2 可以方便快速共享文档, 管理文件.

8.为每个项目设置独立的wiki和讨论区

8.1 Wiki使用textile语法, 可以通过方括号标记设置指向在wiki内部的任意页面;

8.2 提供历史记录的对比和注释功能.

9.版本库浏览器和对比查看器

9.1 可以为每个项目绑定已有的版本库;

9.2Redmine使您可以浏览版本库的内容, 查阅和搜索变动;

9.3 对比和注释(即追溯)查看器;

9.4支持的版本管理系统: Subversion, CVS, Mercurial, Darcs , Bazaar, git and Filesystem .

10.邮件通知

项目活动、变更、新闻、问题、问题变更都可通过/邮件获取通知.

11.支持用户自注册

11. 1 可以配置系统允许用户在线注册；

11.2 提供3种用户激活方式：自动激活（不需要确认）、手动激活（由管理员激活）、通过邮件自动发送的邮件激活.

三、用户视图

1.注册和登陆

Redmine安装在131服务器上，http://10.1.5.131:8082/，进入之后，点击Access Bitnami进入Redmine主页，在右上角点击注册账号，有账号的点击登录，输入用户名, 密码登陆.

2.主页

2.1 登陆成功后显示主页；

2.2 主页显示欢迎使用,最近的新闻以及最近更新的项目, 都可以快速方便的查看；

2.3 还可以通过导航菜单进入相应的功能模块.

3.我的工作台

3.1指派给我的问题: 提供一个跨项目的指派给当前用户的问题列表, 显示问题的ID,项目, 跟踪标签的类型和主题, 可以查看所有问题；

3.2 跟踪的问题: 显示所参与的项目中的问题列表, 显示问题的ID, 项目,跟踪标签的类型和主题, 可以查看所有问题；

3.3 已报告的问题: 显示所报告项目中的问题列表, 显示问题的ID, 项目, 跟踪标签的类型和主题, 可以查看所有问题；

3.4 还可以个性化定制我的工作台, 新增日历, 文档, 新闻, 删除列表, 按住每部分内容的标题拖动, 可以调整该内容所在的位置保存, 对我的工作台进行重新布局.

4.我的账号

4.1 点击右上角“我的账号”进入我的账号页面;

4.2可以对自己的姓名, 邮箱, 语言进行修改;

4.3还可以更改邮件通知, 时区, 注释;

4.4修改密码(右上角).

5.项目列表

5.1 在任意界面上都可以通过点击左上角的项目连接进入项目列表界面;

5.2 项目列表中列出您权限范围内的所有项目;

5.3 右上角点击“查看所有问题’”进入问题列表, 对问题进行编辑, 还可以通过日历和甘特图来查看进度;

5.4 点击项目名称可以进入该项目主页(即概述).

6.项目主页

6.1 项目主页(即概述)只要显示项目的说明, 问题跟踪情况, 成员, 新闻等;

6.2 问题跟踪:

1) 错误指该项目中发现的错误;

2) 功能指对该项目提出的新增功能需求;

3) 支持指为项目做出的贡献, 例如提交一个补丁文件;

4) 工作安排指日常的工作安排(需要后台添加,管理员可以添加更多问题类型);

5) 错误,功能,支持, 工作安排这些被称为问题跟踪标签,管理员可以根据本项目的需求增加或者修改;

6.3 成员,显示参与项目的人员结构以及人员名称;

6.4 可以点击右上角计划“日历,甘特图”查看项目进度,工作量统计;

6.5 可以点击右上角耗时“详情,报表’”进入问题列表.

7.什么是问题

7.1 在本系统中, 发现的错误、新提的要求、对工作的安排等都可以被当作问题来处理; 7.2 问题是一个过程性的概念, 从提出问题到解决问题、关闭问题是一个完整的过程,表示了对错误的处理、对新需求的响应或对工作安排的完成情况正处于什么阶段;

7.3 系统默认的问题状态有6种：

1) 新建：表示错误刚被发现、新需求刚被提出、或者工作任务刚被下达;

2) 已指派：表示已经安排了人来处理该问题;

3) 已解决：表示此问题已经被解决;

4) 反馈：表示有人对问题的解决效果提出了反馈意见;

5) 已关闭：表示问题已经彻底解决并通过审核, 可以告一段落. 默认情况下问题列表中将不再显示已经关闭的问题;

6) 已拒绝：认为该问题提出的错误不存在、工作任务不合理等, 拒绝执行此问题.

7.4指派给:

1) 表示已将此问题安排给某人负责解决;

2) 被指派人应全权负责处理此问题.

7.5 问题的状态变化:

1) 问题负责人应及时更新问题状态, 并填写说明;

2) 其他相关人员通过问题状态和说明来了解问题的进度.

7.6邮件通知

1) 问题的提出人（新建问题）和负责人（被指派给）都可以自动收到有关此问题的邮件通知;

2) 问题状态每次变化都会发送通知邮件;

3) 其他用户可以通过‘跟踪’选项来收取某个问题的通知（见后面的问题详情）;

4) 问题创建人可以将相关人员加入跟踪者列表;

5) 用户也可以通过修改自己的账号设置来收取自己参与的项目的所有问题的通知（见前面的“我的帐号”设置.

8.日历:在项目概述右上角点击“日历”

8.1 日历上显示的是每天开始的问题和结束的问题;

8.2可以比较直观的显示问题的进度;

9.甘特图: 在项目概述右上角点击“甘特图”

9.1 显示每个问题的进度;

9.2 如果定义了版本, 会显示每个版本的结束时间;

9.3 可以导出到PDF或者PNG, 连接在右下角.

10.工作量统计: 在项目概述右上角点击“详情, 报表”

10.1 统计解决每个问题的工作量;

10.2 或者按照问题类型进行统计;

10.3 前提是要求负责人更新问题时要登记工作量.

11.活动: 就是指人们在系统上进行各种操作的记录

11.1 所有可以显示的活动类型见右侧边栏;

11.2 对于管理者来说可以看看项目成员每天都在做什么工作;

11.3 在项目列表页面点击‘全部活动’显示的是所有项目的活动（前面已讲过）;

11.4 如果想看看近期有什么新内容, 可以把Wiki和帖子选上, 则可以看到Wiki新增加的内容和讨论区里面新发布的帖子.

12.问题被新建或者被更新后系统将自动发送邮件通知

12.1新建问题前请确认已经选择了正确的项目, 不要把本项目的问题创建到别的项目中去, 项目名称显示在页面左上角;

12.2问题的作者和被指派者将自动收到邮件通知;

12.3邮件通知是系统自动发送的;

12.4你可以直接回复通知邮件, 系统会根据你回复的邮件去更新问题状态. 具体安排待定;

12.5其他用户(非作者和被指派者) 如果也想收到该问题的通知, 可以使用“跟踪’”功能(详见后面的问题详情).

13.问题详情

13.1 问题页面右上角各功能按钮:

1) 编辑: 修改现有的内容, 新增说明等;

2) 登陆工时: 将自己解决此问题所做的工作登记上来, 统计工作量时有用;

3) 跟踪: 希望收到此问题通知邮件的话, 请使用跟踪功能(作者和被指派者不需要跟踪, 而将自动收到通知邮件);

4) 复制: 将此问题复制一份并产生一个新问题, 可以省下敲字的时间;

5) 移动: 将此问题移动到其它项目里, 或者用来修改此问题的跟踪标签;

6) 删除:请慎重使用, 删除后将彻底无法恢复（包括此问题的附件）;

13.2 问题描述可以显示丰富的格式:

1) 例如代码语法高亮显示;

2) 还可以显示图片, 超链接等.

13.3 相关的问题: 允许开发者将某一问题与其他问题建立关联, 从而起到了删除重复问题, 简化工作流的作用, 主要的关联类型有:

1) 关联到: 普通关联关系, 问题A ,B 需要分别关闭

2) 重复: 如果问题A重复于B, 那么关闭A 将自动关闭B

3) 阻挡和被阻挡: 如果问题B阻挡A, 则A无法关闭, 除非B关闭. 被阻挡则相反

4) 优先于: 如果A优先于B, 那么将B的起始日期自动设置为A的截止日期+延迟天数+1 .

14. 更新问题

14.1 负责人必须在有变化时及时更新问题；

14.2 需要更新问题的几种情况；

1) 提出的问题有误, 需要添加说明, 或者想要提出意见, 注意把说明部分写清楚；

2) 问题状态变化时, 例如状态变为已解决或者已关闭, 完成度变为88%等；

3) 负责人认为不能按照完成日期完成, 可修改完成日期并把原因写入说明；

4) 负责人改变, 修改指派给谁；

5) 登记工时, 登记自己为此项目作出的工作.非常实用的功能, 建议每个人都使用. 不仅仅是对个人工作的认可. 详细的工作量数据将为以后项目的估算提供坚实基础.

15. 发送问题通知邮件

15.1 用户也可以自己来点击跟踪按钮实现跟踪功能；

15.2 跟踪者打开问题页面后,跟踪按钮将变为‘取消跟踪’ , 用户点击取消跟踪按钮后将可以从跟踪者列表中退出, 而不再收到该问题的通知；

15.3 要求: Redmine版本高于0.7.devel.1715 ：

1) 通过问题的跟踪者功能来实现对多人的通知；

2) 问题有变化后会向所有跟踪者发送通知；

3) 跟踪者刚被添加进来后不能立即发送问题现状的邮件给他, 必须要等问题有变化后他才能开始收到通知；

15.4 用法：

1) 在问题详情页面上的跟踪者区域里面点新增, 然后选择需要得到通知的成员即可；

2) 所有跟踪者将在下次问题更新后得到通知.

16. 问题注意事项

16.1 问题的负责人务必及时更新问题的状态. 如果问题解决完了, 就把完成度选成100%, 状态选成已关闭, 同时写上说明, 让关心的人知道问题被如何解决:；

16.2问题解决后完成后一定要把状态改为关闭, 完成度改成100%不会自动关闭问题；16.3 问题关闭后才会在问题列表中隐藏, 否则永远占着位置；

16.4问题是一个过程, 一定要有新建→ 处理→ 反馈→ 完成→ 关闭这种类似流程的事情才应该使用问题来处理；

16.5纯通知性问题直接发邮件即可, 如果通知特别想要留记录或者得到反馈, 也可以新建问题, 但应注意及时关闭；

16.6 文档的共享和保存应该使用文件或文档功能, 而不是问题功能；

16.7 信息的共享和保存应该使用Wiki功能；

16.8更新问题时不必修改指派给谁, 因为负责人不会变来变去. 创建问题的人、被指派的人、以及跟踪者都会同时收到问题通知；

16.9新建问题前请先看问题列表, 如果已经有了相应的问题在说一件事, 就不要再重复新建问题了, 应该是到那个问题上去更新. 如果需要通知给多人, 应使用跟踪者功能, 而不是建立多个问题依次指定给所有人.

17. 新闻, 有权限的用户可以为项目添加新闻

17.1可以用来介绍项目的新进展；

17.2 最新的新闻也会显示系统首页和项目主页上；

17.4通过右上角的添加新闻按钮来添加（没权限看不到）；

17.5右下角有RSS订阅按钮.

18. 文档: 与本项目相关的文档可以统一放在这里管理

18.1 管理员可以增加文档的类别；

18.2 可以为文档添加说明；

18.3一份文档可以包含多个文件；

18.4 在列表页上可以按照文档类别、日期、标题、作者进行排序.

19. Wiki

19.1 简介: Wiki一词来源于夏威夷语的“wee kee wee kee”, 发音wiki, 原本是“快点快点”的意思, 被译为“维基”或“维客”. 一种多人协作的写作工具. Wiki站点可以有多人（甚至任何访问者）维护, 每个人都可以发表自己的意见, 或者对共同的主题进行扩展或者探讨. Wiki也指一种超文本系统. 这种超文本系统支持面向社群的协作式写作, 同时也包括一组支持这种写作的辅助工具. Wiki发明者是一位Smalltalk程序员沃德?坎宁安(Ward Cunningham), Wiki包含一套能简易制作与修改HTML网页的系统, 再加上一套记录和编排所有改变的系统, 并且提供还原改变的功能. 使用Wiki系统的网站称为Wiki网站, 允许任何造访它的人快速轻易地添加、删除和编辑所有的内容, 而且通常都不须登录, 因此特别适合团队合作的写作方式;

19.2WiKi是一个供多人协同写作的系统. 与博客、论坛等常见系统相比, WiKi有以下特点：1) 使用方便: 快速创建、更改网站各个页面内容, 基础内容通过文本编辑方式就可以完成, 使用少量简单的控制符还可以加强文章显示效果, 通过简单的“[[条目名称]]”, 可以直接产生内部链接. 外部链接的引用也很方便；

2) 自组织: 同页面的内容一样, 整个超文本的相互关联关系也可以不断修改、优化, 系统内多个内容重复的页面可以被汇聚于其中的某个, 相应的链接结构也随之改变；

3) 可增长: 页面的链接目标可以尚未存在, 通过点选链结, 我们可以创建这些页面, 使系统得以增长, 记录页面的修订历史, 页面的各个版本都可以被取得；

4) 开放性: 社群内的成员可以任意创建、修改、或删除页面, 系统内页面的变动可以被来访者清楚观察得到.

19.3Redmine包含一个简单的Wiki系统:

1) 不需要会编写网页, 可以很容易把各种资料做成网页形式分享, 不比使用WORD更困难;

2) 所有有权限的用户都可以随时增加条目或者编辑现有内容, 实现协作创造;

3) 所有修改都有历史记录, 并可还原至前面的某一版本;

4) 右侧连接可以查看所有条目的列表, 并按照标题或者日期排序;

5) 可以包含附件, 如图片等;

6) 提供丰富的格式, 包括粗体、列表、超链接、嵌入的图片、代码语法高亮等;

7) 因为创建和修改十分方便, 因此不必等资料完善后才开始添加;

8) 制作表格非常方便, 内容填完, 网页上内容就显示出来;

9) 最大的优点是协作创作：不需要专门的管理员, 没有专门的后台程序;

10) 任何人只要想为系统添砖加瓦, 都可以随时添加, 没有技术门槛, 不需学习编辑软件.

4. Wiki编辑：

1) 创建一个新的wiki页面: 在任何一个wiki页面, 仅仅需要添加一个你想要创建的新页面的链接；

2) 保护wiki页面: 如果你拥有保护wiki页面的权限, 你可以点击‘锁定’ 连接保护该wiki页面. 已锁定的wiki页面只允许拥有保护wiki页面权限的用户编辑. 拥有此权限的用户同样可以为该页面解锁；

3) Wiki页面的历史: Redmine保存每一次wiki页面的改动历史. 通过点击‘历史’ 链接你可以浏览这些变更. 点击变更的序列号可查看每一个具体版本的页面信息. 你可以通过点击‘回退到这个版本’ 的链接回退到该页面先前的版本.

20. 讨论区

20.1用户可以在这里任意发布各种信息, 讨论, 求助等内容;

20.2每个项目有自己的讨论区（1个或多个）;

20.3 管理员可以随时为项目添加或删除讨论区.

21. 文件: 为用户提供文件下载服务的地方

21.1 按照版本分类；

21.2 可以上传与某个版本相关的文件；

21.3 文件大小限制为10M ；

21.4 不要传过大文件, 大文件应放到其他地方保存(如FTP).

22. 配置

22.1信息: 在这里主要是配置项目的一些信息

1) 项目名称: 可以设置项目名称；

2) 上级项目: 指定该项目的父项目, 在Redmine0.9版本之前, 只允许2级嵌套. 0.9版本之后可以无限嵌套；

3) 项目描述: 可以对项目进行详细的说明, 可以设置字体, 颜色,插入图片, 链接,如果格式有问题还可以点击右边‘文本格式帮助’ ;

4) 标示: 由于Redmine支持多项目, 而且采用REST架构, 所以需要一个URL的唯一标示, 这

个在创建项目的时候填写, 一旦创建成功就不能修改;

5) 主页: 主页链接会显示在项目概述页面中;

6) 是否公开: 如果选中, 该项目将允许所有用户浏览, 包括非项目成员的用户. 如果不选中, 只有项目成员才有权限访问;

7) 跟踪标签: 这里可以设置开启哪些跟踪标签, 默认可用的有三种: 错误, 功能和支持, 根据项目需要进行添加;

8) 自定义属性: 例如电话, 邮箱, 联系人, 公司名称等, 根据项目需要自行添加;

22.2 模块: 项目中所需要的模块, 根据项目需要, 添加项目模块;

22.3成员: 指定项目成员, 以及成员所具有的角色. Redmine 0.9以后可以以组为操作单元, 给组赋予角色, 添加到项目中. 这样该组的所有成员都成为该项目的成员, 且属于相同的角色, 相同的权限

22.4版本: 可以对变更进行跟踪和计划, 你可以个问题指定目标版本, 然后再线路图中就能看到与该版本关联的问题列表. 版本包括的属性:

1) 名称;

2) 描述;

3) 状态, 这个属性是Redmine 0.9添加的,这些状态控制问题如何被指定目标版本. 打开:默认值, 没有权限; 锁定: 不能再给该版本指定新问题; 关闭: 不能再给该版本指定新的问题, 而且不能重新打开已经指定目标版本的问题;

4) Wiki页面, 可以将该版本的主要事件写入wiki里面, 以供浏览该版本时显示可选属性;

5) 日期, 版本完成的日期;

22.5问题类别: 可以有效组织管理项目的问题;

22.6 Wiki: 每个项目都可以有自己的wiki ;

22.7 讨论区: 每个项目都可以有一个或多个讨论区;

22.8默认情况下, 活动阶段有‘开发’ 和‘测试’两种类型, 管理员可以根据需要创建.只有选中的活动阶段才会出现在登记工时页面的下拉框中.

四、管理视图

1.项目

对项目进行管理,可进行的操作有存档, 复制, 删除, 还可以新增项目.

2.用户

可设置用户基本信息,添加到某一分组, 设置在项目中的身份. 可以添加新用户,输入用户登录名, 姓名,设置初始账户密码, 选择注册方式(通过邮件通知的选项) 保存即可添加用户. 添加完成在用户列表那里点击用户名后就可以给用户分组, 分角色, 分项目了.

3.组

添加新的分组, 给组分配用户, 将组分配到项目并指定角色. 操作比较简单, 单击用户组

名进入操作页面.

4.角色和权限

本系统现在所有的角色, 其中非系统成员, 匿名用户在分配权限时会有限制, 其他角色可以根据需求分配权限. 可以对角色进行排序(置顶, 上移, 下移, 置底),删除.

5.跟踪标签

跟踪标签代表不同的问题类型, 默认情况下有3种标签: 错误, 功能和支持,管理员可以根据项目需求添加跟踪标签:

1. 名称: 填写跟踪标签名称;

2. 是否在更新日志中显示问题;

3. 从以下选项复制工作流程:新建的跟踪标签可以从已经存在的跟踪标签中复制工作流,如果不选, 那么新建的跟踪标签的工作流为空;

4. 项目: 可以指定新建的跟踪标签用于哪些项目中.

6.问题状态

管理员可以根据项目需要自由的添加和删除问题状态. 问题状态有3个属性:

1. 名称: 问题状态的名称;

2. 已关闭的问题: 如果选中, 则表示处于该状态的问题属于已经关闭的问题(可以声明多个状态属于已关闭的状态);

3. 默认值: 指定新建问题的默认状态(只能有一个状态属于默认状态).

7.工作流程

为了让某一角色用户能够改变问题的状态, 你需要给予他们可变更问题状态的权限. 工作流程使你可以定义不同角色的项目成员对不同类型的问题所能做的问题状态变更. 在工作流设置页面, 选择你想要编辑的角色和跟踪标签, 点击‘编辑’按钮, 跳转到编辑页面, 可以编辑该角色对该标签所能做的变更状态. 页面左侧列出了该跟踪标签所有的状态, 你可以在右侧选择针对该状态该角色可以变更的专题.

8.自定义属性

1. 名称: 就是自定义属性的名称;

2. 格式: 自定义属性的格式, 有7种格式:

1) 文本: Text；

2) 长段文本: Long Text ；

3) 整数: Integer ；

4) 浮点数: Float ；

5) 列表: List ；

6) 日期: Date ；

7) 布尔量: Boolean ；

3. 最小- 最大长度: 决定自定义属性的字段长度(0表示没有限制) ;

4. 正则表达式: 通过指定的正则表达式, 对自定义属性的内容进行验证;

5. 默认值: 自定义属性的默认值;

6. 跟踪标签: 设置该自定义属性可以在哪些跟踪标签中使用;

7. 必填: 该自定义属性是否是自定义字段;

8. 用于所有项目: 该自定义属性是否用于所有项目中；

9. 作为过滤条件: 该自定义属性是否作为过滤器的过滤条件；

10. 可用作搜索条件: 该自定义属性是否可以用作搜索时的搜索条件.

9.枚举值

在计算机编程语言中, 枚举类型是一种基本数据类型而不是构造类型, 它用于声明一组命名的常数, 当一个变量有几种可能的取值时, 就可以定义为枚举类型. Redmine允许管理员对实体添加枚举值, 从而扩充这些实体可选择的值: 活动(时间跟踪), 文档类别, 问题优先级, 这些枚举值是跨项目的, 管理员可以任意的添加/修改/删除, 枚举值包含的字段有3种:

1. 名称: 指定枚举值的名称;

2. 活动: 只有选中的枚举值才能被使用;

3. 默认值: 如果选中, 那么在使用同类枚举值时该枚举值默认被选中, 同一类枚举值的默认值只能设置一个.

10.配置: 对整个系统进行全局性的设置

1. 一般: 这里可以设置整个系统的基本信息, 包括应用程序标题, 欢迎文字之类的设置, 还可以设置格式, 大小等等;

2. 显示: 主要设置整个系统页面的样式, 格式, 语言, 时间格式, 是否使用头像;

3. 认证: 主要设置一些账号密码认证,自动登录,密码长度;

4. 项目: 这里可以配置一些项目的功能模块, 项目是否公开, 非管理员用户新建项目时被赋予的(在该项目中)角色;

5. 问题跟踪: 设置是否项目之间问题关联, 根据项目需要勾选需要的问题列表中的默认列, 还可以设置输出问题条目的数量限制;

6. 邮件通知: 可以设置哪些动作可以发送邮件通知, 以及邮件发送人的地址和邮件签名;

7. 接收邮件: 是否启用接收邮件的服务;

8. 版本库: 设置版本库的一些基本信息.

11.插件

Redmine提供一些Plugin 来扩展应用程序,提高兼容性帮助点击帮助, 进入Redmine 官方网站, 它会提高一些帮助给你.