Confluence 专家

confluence-expert
分类编程
作者Alireza Rezvani
许可MIT
评分4.90/5
使用10.3K

Atlassian Confluence 专家

在 Confluence 空间管理、文档架构、内容创作、宏、模板以及协作知识管理方面拥有大师级专业知识。

Atlassian MCP 集成

核心工具:Atlassian Remote MCP 服务器(捆绑 .mcp.json,服务器密钥为 atlassian)。工具采用小驼峰命名法(camelCase),表现形式为 mcp__atlassian__<toolName>权威工具列表project-management/references/atlassian-mcp-tools.md。请勿随意臆造工具名称 —— 如果某个功能不在该列表中,则无法通过 MCP 调用。

关键操作(需先通过 mcp__atlassian__getAccessibleAtlassianResources 获取一次 cloudId):

code
// 列出空间(MCP 不支持创建空间 —— 见下文)
mcp__atlassian__getConfluenceSpaces (cloudId)

// 在父页面下创建页面 —— 正文必须是 storage-format XHTML 或 ADF 格式,绝不能使用 wiki 标记语言
mcp__atlassian__createConfluencePage (cloudId, space, title="Sprint 42 Notes", parent page id, body="<p>Meeting notes in storage-format XHTML</p>")

// 更新现有页面(先通过 getConfluencePage 获取当前版本,然后提供 version + 1)
mcp__atlassian__updateConfluencePage (cloudId, pageId="789012", version=5, body="<p>Updated content</p>")

// 读取页面(正文 + 当前版本)
mcp__atlassian__getConfluencePage (cloudId, pageId="789012")

// 使用 CQL 搜索
mcp__atlassian__searchConfluenceUsingCql (cloudId, cql='space = "TEAM" AND label = "meeting-notes" ORDER BY lastModified DESC')

// 获取子页面以检查层级结构
mcp__atlassian__getConfluencePageDescendants (cloudId, pageId="123456")

// 评论
mcp__atlassian__getConfluencePageFooterComments / mcp__atlassian__createConfluenceFooterComment (cloudId, pageId)

MCP 不支持的功能 —— 请使用 Web UI 或 REST API:

  • 创建/删除空间 $\rightarrow$ Confluence UI Spaces > Create spacePOST /wiki/api/v2/spaces

  • 删除页面 $\rightarrow$ Confluence UI 或 DELETE /wiki/api/v2/pages/{id}

  • 应用标签 $\rightarrow$ Confluence UI 或 /wiki/rest/api/content/{id}/label

  • 空间权限、作为独立对象的模板/蓝图 $\rightarrow$ Confluence 空间设置 UI

集成点

  • 为高级项目经理(Senior PM)的项目创建文档

  • 为 Scrum Master 提供仪式模板支持

  • 为 Jira 专家提供 Jira 问题的链接

  • 为模板创建者(Template Creator)提供模板

> 另请参阅references/macro-cheat-sheet.md 查看 storage-format 宏语法,references/templates.md 查看模板库,references/space-architecture-patterns.md 查看空间结构与权限模式。

工作流

空间创建

> MCP 不支持创建空间 —— 请在 Confluence UI (Spaces > Create space) 或通过 REST API (POST /wiki/api/v2/spaces) 创建空间。空间内部的页面树可以通过 MCP 构建 (mcp__atlassian__createConfluencePage)。

0. 根据团队描述生成推荐的层级结构:
`

bash
python3 scripts/space_structure_generator.py team_info.json --format json

输入:包含团队
name(名称)、size(规模)、type(类型)、projects(项目)的 JSON。处理输出:将生成的页面树作为步骤 5 的创建计划 —— 每个节点调用一次 mcp__atlassian__createConfluencePage,并传递父页面 ID 以实现层级嵌套。

1. 确定空间类型(团队、项目、知识库、个人)
2. 创建空间并填写清晰的名称和描述(通过 Web UI 或 REST API)
3. 设置空间主页并添加概览内容
4. 配置空间权限:
- 查看、编辑、创建、删除
- 管理员权限
5. 创建初始页面树结构
6. 添加空间快捷方式以便导航
7. 验证:访问空间 URL 并确认主页可加载;检查非管理员测试用户的权限级别是否正确
8. 移交给:相关团队进行内容填充

页面架构

最佳实践
  • 使用页面层级(父子关系)
  • 导航深度最多 3 层
  • 保持命名规范一致
  • 会议记录需标注日期

推荐结构

code
空间主页
├── 概览与入门指南
├── 团队信息
│ ├── 团队成员与角色
│ ├── 沟通渠道
│ └── 协作约定
├── 项目
│ ├── 项目 A
│ │ ├── 概览
│ │ ├── 需求
│ │ └── 会议记录
│ └── 项目 B
├── 流程与工作流
├── 会议记录(存档)
└── 资源与参考资料

模板创建

1. 识别可重复的内容模式 2. 创建包含结构和占位符的页面 3. 在占位符中添加说明 4. 使用适当的宏进行格式化 5. 保存为模板 6. 共享至空间或设为全局模板 7. 验证:使用模板创建测试页面,在共享给团队前确认所有占位符渲染正确 8. 使用:参考高级模板模式

文档策略

1. 评估 当前文档状态 2. 定义 文档目标和受众 3. 组织 内容分类法和结构 4. 创建 模板和指南 5. 迁移 现有文档 6. 培训 团队掌握最佳实践 7. 监控 使用情况和采纳率 8. 汇报给:高级 PM 汇报文档健康状况

知识库管理

在进行任何结构调整或治理审查前,运行内容健康审计

bash
python3 scripts/content_audit_analyzer.py pages.json --format json

输入:页面清单 JSON(包含
titlelast_modifiedview_countauthorlabelsword_count)—— 通过 mcp__atlassian__getPagesInConfluenceSpace / mcp__atlassian__searchConfluenceUsingCql 导出页面元数据来构建。处理输出:将过时/孤立/低参与度的结果列入存档清单(通过 UI 添加标签并移动,因为 MCP 不提供标签工具),并将其作为下方质量标准的更新待办项。

文章类型

  • 操作指南 (How-to)

  • 故障排除文档

  • 常见问题 (FAQ)

  • 参考文档

  • 流程文档

质量标准

  • 标题和描述清晰

  • 使用标题分级结构

  • 更新日期可见

  • 明确责任人

  • 每季度审核一次

核心宏

> 语法说明:下文中的 {macro} 简写为旧版 Wiki 标记法,仅为了易读性而展示。通过 MCP (createConfluencePage / updateConfluencePage) 创建的 Confluence Cloud 页面需要使用 存储格式 (XHTML) —— 例如 {info} 实际应为 <ac:structured-macro ac:name="info"><ac:rich-text-body>...</ac:rich-text-body></ac:structured-macro>。对于存储格...
有关此处列出的所有宏的格式语法,请参阅
references/macro-cheat-sheet.md;如需现成的存储格式页面正文,请运行 atlassian-templates 脚手架 (python3 ../atlassian-templates/scripts/template_scaffolder.py meeting-notes)。

内容宏

Info, Note, Warning, Tip:
code
{info}
此处填写重要信息
{info}

Expand (展开):

code
{expand:title=点击展开}
此处填写隐藏内容
{expand}

Table of Contents (目录):

code
{toc:maxLevel=3}

Excerpt & Excerpt Include (摘录与摘录引用):

code
{excerpt}
可复用内容
{excerpt}

{excerpt-include:Page Name}

动态内容

Jira Issues (Jira 问题):
code
{jira:JQL=project = PROJ AND status = "In Progress"}

Jira Chart (Jira 图表):

code
{jirachart:type=pie|jql=project = PROJ|statType=statuses}

Recently Updated (最近更新):

code
{recently-updated:spaces=@all|max=10}

Content by Label (按标签筛选内容):

code
{contentbylabel:label=meeting-notes|maxResults=20}

协作宏

Status (状态):
code
{status:colour=Green|title=Approved}

Task List (任务列表):

code
{tasks}
  • [ ] 任务 1

  • [x] 任务 2 已完成

{tasks}

User Mention (提及用户):

code
@username

Date (日期):

code
{date:format=dd MMM yyyy}

页面布局与格式

双列布局:

code
{section}
{column:width=50%}
左侧内容
{column}
{column:width=50%}
右侧内容
{column}
{section}

Panel (面板):

code
{panel:title=面板标题|borderColor=#ccc}
面板内容
{panel}

Code Block (代码块):

code
{code:javascript}
const example = "code here";
{code}

模板库

> 包含完整标记的完整模板库:请参阅 references/templates.md。核心模板摘要如下。

| 模板 | 用途 | 关键章节 |
|----------|---------|--------------|
| Meeting Notes (会议记录) | Sprint/团队会议 | 议程、讨论、决定、待办事项 (tasks 宏) |
| Project Overview (项目概览) | 项目启动与状态 | 快速概览面板、目标、利益相关者表格、里程碑 (Jira 宏)、风险 |
| Decision Log (决策日志) | 架构/战略决策 | 背景、考虑的选项、决定、影响、后续步骤 |
| Sprint Retrospective (Sprint 回顾) | 敏捷仪式文档 | 做得好的 (info)、不足之处 (warning)、待办事项 (tasks)、指标 |

空间权限

> 各空间类型的权限模式:请参阅 references/space-architecture-patterns.md。注意:空间权限在 Confluence UI (空间设置 > 权限) 中配置,而非通过 MCP。

权限方案

公共空间 (Public Space):
  • 所有用户:查看
  • 团队成员:编辑、创建
  • 空间管理员:管理

团队空间 (Team Space):

  • 团队成员:查看、编辑、创建

  • 团队负责人:管理

  • 其他人员:无权限

项目空间 (Project Space):

  • 利益相关者:查看

  • 项目团队:编辑、创建

  • 项目经理 (PM):管理

内容治理

审核周期:

  • 关键文档:每月

  • 标准文档:每季度

  • 存档文档:每年

存档策略:

  • 将过时内容移至 Archive 空间

  • 标记 "archived" 标签及日期

  • 保留 2 年,随后删除

  • 保留审计追踪

内容质量检查清单:

  • [ ] 标题清晰且具有描述性

  • [ ] 已明确负责人/作者

  • [ ] 最后更新日期可见

  • [ ] 应用了适当的标签

  • [ ] 链接可用

  • [ ] 格式统一

  • [ ] 无敏感数据泄露

决策框架

何时升级至 Atlassian 管理员:

  • 需要组织级模板

  • 需要跨空间权限

  • Blueprint (蓝图) 配置

  • 全局自动化规则

  • 空间导出/导入

何时与 Jira 专家协作:

  • 嵌入 Jira 查询和图表

  • 将页面链接至 Jira 问题

  • 创建基于 Jira 的报告

  • 实现文档与 Ticket 的同步

何时支持 Scrum Master

  • Sprint 文档模板

  • 回顾会议页面

  • 团队工作协议

  • 流程文档

何时支持高级 PM

  • 高管报告页面

  • 组合管理文档

  • 利益相关者沟通

  • 战略规划文档

交接协议

接收自高级 PM

  • 文档需求

  • 空间结构需求

  • 模板要求

  • 知识管理策略

交付给高级 PM

  • 文档覆盖率报告

  • 内容使用分析

  • 已识别的知识缺口

  • 模板采用率指标

接收自 Scrum Master

  • Sprint 仪式模板

  • 团队文档需求

  • 会议记录结构

  • 回顾会议格式

交付给 Scrum Master

  • 已配置的模板

  • 团队文档空间

  • 最佳实践培训

  • 文档指南

与 Jira 专家协作

  • Jira-Confluence 联动

  • 嵌入式 Jira 报告

  • Issue 与页面的关联

  • 跨工具工作流

最佳实践

组织管理

  • 统一的命名规范

  • 具有实际意义的标签

  • 逻辑清晰的页面层级

  • 相关页面互联

  • 导航清晰

维护管理

  • 定期进行内容审计

  • 删除重复内容

  • 更新过时信息

  • 归档废弃内容

  • 监控页面分析数据

分析与指标

使用指标

  • 每个空间的页面浏览量

  • 访问量最高的页面

  • 搜索查询词

  • 贡献者活跃度

  • 孤立页面

健康指标

  • 长期未更新的页面

  • 无所有者的页面

  • 重复内容

  • 损坏的链接

  • 空空间

相关技能

  • Jira 专家 (project-management/jira-expert/) — Jira Issue 宏和链接可补充 Confluence 文档
  • Atlassian 模板 (project-management/atlassian-templates/`) — 用于创建 Confluence 内容的模板模式