Atlassian-confluence工具

840 阅读9分钟

参考网址

www.cnblogs.com/xutianju/p/…

1/confluence简介

confluence是Atlassian公司开发的一款产品(工具),主要面向的领域是企业的知识管理和协同编辑。
Atlassian公司是在2002年在澳大利亚悉尼成立,是一家SaaS公司,提供面向企业的业务流程的协同办公产品,并在2015年在美国纳斯达克上市。
Atlassian这家公司主要有5款产品,分别面向不同的市场:
   confluence:企业知识管理和协同编辑软件
   jira:项目任务管理
   bitbucket:代码管理(类似于gitlab)
   hipchat:内部聊天软件(类似于阿里的钉钉,头条的飞书,腾讯的wechat企业微信等)
   jira service desk:服务台软件

以上5款产品,当然最核心的产品还是confluence和jira。
confluence被公认为是世界上最好用的企业知识管理和协同编辑软件
jira被公认为是世界上最好用的项目管理和开发管理工具。美国航天局,宝马,花旗等世界500强公司都使用过jira.

Confluence是一个企业级的Wiki服务软件(工具)。
可用于在企业、部门、团队内部进行文档的协同编辑和信息共享。
类似于ks的docs协同编辑系统。

wiki是一个大的概念,功能是用于多人协作编辑。
而confluence是wiki这个概念中一个具体的服务软件,另外还有很多软件都是wiki,比如ks的docs.

这就好比`感冒药`是一个概念,其中有很多具体的感冒药,比如999感冒颗粒,快克,感康等都是具体的一种感冒药。

2/confluence基本概念

Confluence的使用并不复杂,只需掌握如下几个基础概念。

<1>Dashboard

Dashboard是Confluence系统的主页。
在Dashboard这个主页中包含了confluence站点中的所有空间列表,以及最近更新内容的列表。
所以,你可以把dashboard这个主页看作是一个导航页,是一个总的概括。
你可以在dashboard这个主页中看到该系统中所有的已经创建的空间,从而可以随意点击切换到具体的空间中去。

<2>空间Space

 空间是Confluence系统中的一个区域(可以理解为是一个文件夹,文件夹中还可以有文档和子文件夹),
 用于存储wiki文档,并可实现对空间中的所有文档进行统一的权限管理。
 
 通常在使用的时候,我们可以针对每个项目单独创建一个空间,然后将与该项目相关的文档信息放置到该空间中,并只对项目成员开放访问/编辑权限。
 
 除了项目空间,每个成员都有一个个人空间。
 每个人都可以有自己的个人空间。
 可以将工作总结或笔记等文档放到自己的空间中,如果对于对团队有帮助的文档,就可以将文档移动至团队项目空间中。
 
 总结:
   空间分为2种:
      项目空间:针对一个项目创建一个空间,所以与该项目有关的文档都放在这个项目空间中。
               该项目空间只对项目内的员工开放权限。
      个人空间:每个人都可以创建一个属于自己的空间。平时可以把自己的一些工作总结放在自己的空间中。
               如果自己空间中的文档很有价值,对团队有所帮助,则可以把该文档移动到项目空间中去。
      

<3>页面Page

页面,可以理解为就是空间中的文档,就是一篇又一篇的文章。
在Confluence系统中,页面是存储和共享信息的主要方式。
页面可以互相链接、连接、组织和访问,并以树状结构进行组织,放置于空间之中。

页面遵循所见即所得的编辑方式,操作上简单易用。
更强大的地方在于,页面支持大量的内容展现形式,除了富文本文档外,还包括图表、视频、附件(可预览)、流程图、公式等等;如果还不够,还可以通过海量的第三方插件进行扩展。

  在页面中可以通过@其它成员,通知相关成员查看文档。 文档保存成功后,被@的成员就会收到邮件,并可根据邮件中的链接访问到该文档,然后进行评论或者协同编辑。

<4>模板template

创建页面(写文档的时候)时除了采用空白页面(文档),也可以选择模板文档。
模板是在空白文档的基础上,根据特定需求添加了一些文档要素,可辅助用户更好更快地创建文档。

Confluence内置了大量的模板,可辅助用于项目工作的各个环节,包括产品需求、会议记录、决策记录、指导手册(How-to)、回顾记录、工作计划、任务报告等等。
并且由于Confluence和JIRA是同一家公司的产品,在Confluence中可以和JIRA进行无缝衔接,实现对产品质量实现更好的展现。

如果对Confluence自带的模板不满意,还可以对模板进行调整,或者根据自己的需求创建其它类型的模板。

<5>权限Permission

 在安全性方面,Confluence具有完善和精细的权限控制,可以很好地控制用户在Wiki中创建、编辑内容和添加注释。
 权限控制分3个维度,分别是团队(Group),个人(Individual Users),匿名用户(Anonymous)。
 使用团队级的权限控制时,需要在Confluence服务器中对公司员工进行分组,好处在于配置比较方便,只需要对整个团队进行统一的权限配置。比如我需要把某一篇文档的权限开给某个组,那么这个组的成员就可以看到我的这篇文档。
 
 但在实际项目中,经常会存在同一个项目包含多个跨团队成员的情况,这个时候就不适合采用团队权限配置方式,只能采用逐个添加成员的方式,并对各个成员分别配置权限。
 另外一种情况,就是对于未登录的用户,以及项目成员以外的用户,可以开设部分权限,例如只读(View)。

3/常见操作

熟悉了Confluence是什么以及几个重要的概念之后,基本上就可以摸索着对Confluence进行上手了。
不过,为了减少摸索时间,在这里我再将Confluence中的常用操作进行说明。

<1>创建空间(Space)

新建一个项目时,首先要做的就是创建一个项目空间,并进行初始化配置。

创建空间的方式很简单,可以从顶部菜单进行创建:【Spaces】->【Create Space】;也可以从Dashboard页面的Spaces页面中进行创建。

进入创建空间页面后,需要选择空间类型。这个需要根据空间的用途进行选择,对于团队协作的空间,推荐选择“Team Space”,如果实在不知道选择什么类型,选择“Blank Space”也是可以的。

然后是填写空间的基本信息。所有类型的空间都有两个必填字段,Space name和Space key。Space key可以理解为空间的ID,不同空间的Space key不能重复,但Space name是可以重复的。

另外,对于“Team Space”类型的空间,多了一个“Team members”字段,用于添加空间的成员。成员的名称是其公司邮箱的前缀。

需要说明的是,空间创建完成后,Space key字段是不能修改的,其它字段以及团队成员都可以进行修改。

<2>配置空间权限

创建空间后,根据项目需要,可以给空间设置权限。
当然只有空间的管理员才能对空间权限进行配置,并不是所有的人都可以配置空间的权限。

操作方式如下:首先进入空间的页面,在空间左下角中,【Space tools】->【Permissions】,进入权限管理页面。

Confluence的权限控制比较完善,可以根据团队规范进行较为精细粒度的设置。

<3>创建文档

在Confluence中文件以树状结构进行组织。

推荐的创建方式是,先进入父目录的页面,然后再点击【Create】进行创建。
在创建文档页面中,可以看到新建文档的“Parent”,表示新文档创建后将位于“Parent”文件的下一个层级中。

在创建文档时,需要选择文档模板。
这个就根据文档的实际类型或用途进行选择即可,如果觉得都不合适,就选择“Blank page”,及空白文档。

<4>编写文档

在编写文档时,页面遵循所见即所得的编辑方式,基本上跟在MS Word中的操作类似。
Confluence也集成了许多编辑工具,可以很方便地插入图表、链接、附件、代办列表等等。如果还不满足需求,可以点击【Insert】->【Other macros】,查找更多的扩展插件。

当前confluence还不支持markdown语言来编辑,如果你非常想用markdown来编写文档,
你可以去找一个markdown的插件安装上。
不过根据实践发现,当前Confluence的Markdown插件支持的还不够好,使用体验上不尽如人意。
比较推荐的做法,还是在单独的Markdown编辑器上采用markdown语法进行编辑,编辑完成后进行预览,然后将渲染后的文档内容复制粘贴到Confluence中。

<5>移动文档

很多时候我们需要调整目录结构,这就涉及到需要将文档移动到别的目录层级下。
操作方式如下:先进入到待移动的文档页面中,点击页面右上角的【…】->【Move】;

4/总结

confluence是一个协同编辑和信息共享的系统,类似于ks自研的docs.
confluence系统的主页是Dashboard,在这个页面中,你可以看到所有的空间,方便你直接进行切换。
几个概念:
    空间:项目空间,个人空间
    文档:就是文章,文章是位于空间中的
    模版:在创建文档的时候,如果你不想创建空白的文档,可以选择系统提供的模版文档。
    权限:为了保证信息的安全,权限是必须要有的。
         又很多维度的权限。比如空间颗粒度的权限,文档颗粒度的权限。
         只读权限,读写权限,评论权限。

先创建空间(项目空间或者个人空间)
再创建文档(空白文档或者模版文档)
目前不支持markdown编辑,可以安装插件,但是目前这种插件这种方式也是很好。
所以,可以先在markdown编辑器上编辑,然后复制到confluence的文档中。
移动文档,我们可以把文档在目录之间进行移动。