名称: confluence-docs 描述: 提供用于架构决策记录（ADRs）、操作手册和架构文档的文档模板。在创建架构决策记录、操作手册或技术文档时使用。
Confluence 文档技能
目的
提供创建技术文档的标准化模板。这些模板确保项目中文档的一致性和高质量。
适用场景
在以下情况下使用此技能：
- 创建架构决策记录（ADRs）
- 编写操作手册
- 记录系统架构
- 创建技术规范
- 编写知识转移（KT）文档
现有 ADRs（参考）
| ADR | 位置 | 主题 |
|---|---|---|
| ADR-002 | docs/adr/ADR-002-constants-unification.md |
常量组织 |
| ADR-003 | docs/adr/ADR-003-dependency-upgrade-typescript-fixes.md |
依赖升级 |
| ADR-004 | docs/adr/ADR-004-server-component-data-access-pattern.md |
服务器组件模式 |
| ADR-005 | docs/adr/ADR-005-ci-infrastructure-services.md |
CI 基础设施 |
| ADR-006 | docs/adr/ADR-006-bonus-pdf-private-bucket-security.md |
安全模式 |
| ADR-007 | docs/adr/ADR-007-rendertrust-marketing-pages.md |
营销架构 |
ADR 模板（架构决策记录）
# ADR-XXX: [标题]
## 状态
[提议 | 已接受 | 已弃用 | 已替代]
## 上下文
促使此决策的问题是什么？
## 决策
我们提议和/或实施的改变是什么？
## 后果
### 积极方面
- [益处 1]
- [益处 2]
### 负面方面
- [权衡 1]
- [权衡 2]
### 中性方面
- [观察]
## 实现笔记
如何实施此决策？
## 相关决策
- ADR-XXX: [相关决策]
## 参考资料
- [相关文档链接]
操作手册模板
# 操作手册: [操作名称]
## 概述
简要描述此操作手册的内容。
## 先决条件
- [ ] 访问 [系统]
- [ ] 所需权限
- [ ] 工具安装
## 步骤
### 步骤 1: [操作名称]
\`\`\`bash
# 执行命令
\`\`\`
**预期输出**: 描述应看到的内容
**如果出错**: 如果出现问题该怎么办
### 步骤 2: [操作名称]
...
## 验证
如何验证操作是否成功。
## 回滚
如果需要，撤销操作的步骤。
## 故障排除
### 问题: [常见问题]
**症状**: 看到什么
**原因**: 为什么会发生
**解决方案**: 如何修复
## 联系人
- 主要: [姓名/角色]
- 升级: [姓名/角色]
## 修订历史
| 日期 | 作者 | 更改 |
| ---------- | ------ | --------------- |
| YYYY-MM-DD | 姓名 | 初始版本 |
架构文档模板
# [系统/组件] 架构
## 概述
系统/组件的高级描述。
## 目标与非目标
### 目标
- [此系统应做什么]
### 非目标
- [此系统不应做什么]
## 架构图
\`\`\`
[ASCII 图或图链接]
\`\`\`
## 组件
### 组件 1: [名称]
- **目的**: 功能
- **位置**: 存放位置
- **依赖项**: 所需内容
### 组件 2: [名称]
...
## 数据流
数据在系统中如何流动。
## 安全考虑
- 认证
- 授权 (RLS)
- 数据保护
## 性能考虑
- 缓存策略
- 数据库优化
- API 响应时间
## 监控与可观测性
- 关键指标
- 警报阈值
- 日志位置
## 未来考虑
可能改变或改进的地方。
## 参考资料
- 相关 ADRs
- 外部文档
知识转移（KT）文档模板
# KT: [主题名称] - {{TICKET_PREFIX}}-XXX
## 总结
做了什么以及为何重要。
## 上下文
理解此工作所需的背景信息。
## 关键决策
1. [决策 1]: [理由]
2. [决策 2]: [理由]
## 实现详情
### 更改内容
- 文件: `路径/到/文件.ts`
- 更改描述
### 工作原理
实现的解释。
## 注意事项和教训
可能让未来开发者困惑的地方。
## 测试
如何验证一切正常。
## 相关工单
- {{TICKET_PREFIX}}-XXX: [相关工作]
## 后续工作
下一步应做什么。
文档输出位置
| 文档类型 | 位置 | 命名 |
|---|---|---|
| ADRs | docs/adr/ |
ADR-XXX-{描述}.md |
| 操作手册 | docs/runbooks/ |
{操作}-runbook.md |
| 架构文档 | docs/architecture/ |
{系统}-architecture.md |
| KT 文档 | docs/ |
KT-{{TICKET_PREFIX}}-XXX-{主题}.md |
| 技术文档 | docs/agent-outputs/technical-docs/ |
{{TICKET_PREFIX}}-XXX-{描述}.md |
文档检查清单
发布任何文档前：
- [ ] 清晰、描述性标题
- [ ] 正确的标题层级（H1 > H2 > H3）
- [ ] 带语言标签的代码块
- [ ] 链接到相关文档
- [ ] 包含作者和日期
- [ ] 无敏感数据（秘密、密码）
- [ ] 拼写检查
- [ ] Markdown 语法检查通过（
yarn lint:md）