SuperAPI AI 工具集

Confluence Documentation Patterns

办公与效率

查看项目

更新于 10-16 03:04

技能介绍

用途:在 Confluence 中创建、管理和组织技术文档,并与 Jira 集成。适用于撰写技术设计文档(TDD)、API 文档、架构决策记录(ADR)、运行手册与操作手册、发布说明、会议记录、Sprint 回顾,以及将文档链接到 Jira 问题和搜索文档。

主要能力:提供多种文档模板及要写章节与元数据。TDD 含执行摘要、问题陈述、方案、实现细节、测试策略,元数据含状态、作者、Jira 问题链接、评审人。ADR 含背景、决策、后果、备选方案,状态为 Proposed|Accepted|Deprecated|Superseded。API 文档与运行手册、发布说明、会议记录、Sprint 回顾各有对应章节。

使用方式:提供 Confluence 查询语言(CQL),基本语法为 field operator value,常用字段有 title、text、label、space、type、creator、lastModified、ancestor,操作符包括 =、!=、~(包含)、>、<、>=、<=、IN、AND、OR、NOT。示例:label = "tdd" AND space = "ENG" ORDER BY lastModified DESC;lastModified >= now("-1w") AND space = "ENG";title ~ "API" AND label = "authentication";label = "adr" AND text ~ "Status: Approved";label = "runbook" AND label = "production" AND space = "OPS";label = "draft" AND creator = currentUser()。Jira-Confluence 集成方面,可在 Jira/Confluence 描述中用智能链接指向文档;用 Jira 宏 {jira:PROJ-123} 显示问题卡片;嵌入单问题 {jira:PROJ-123|columns=key,summary,status,assignee},JQL 查询 {jira:jql=project=PROJ AND status="In Progress"|columns=key,summary},问题计数 {jiraissues:project=PROJ AND type=Bug|count},时间线 {jira-chart:type=timeline|project=PROJ}。

最佳实践:在 Jira 问题描述或评论中链接所有文档;一致使用标签(tdd、adr、runbook、api-docs、release-notes);按团队/领域命名空间(ENG、OPS、PRODUCT);文档被取代或弃用后归档。

限制:资料未提供具体安装命令、收费方式、权限要求或平台版本限制,暂未提供。