工程开发
confluence-docs avatar

confluence-docs

为 AI 代理工作流程提供 ADR、运营手册、系统架构与知识转移等标准化技术文档模板。

简介

Confluence Docs 技能为 AI 驱动的开发环境提供了一套结构化的技术文档管理框架。专为开发人员、架构师与技术撰稿人设计,此技能通过强制执行架构决策记录 (ADR)、运营手册、系统架构规范与知识转移 (KT) 文档等标准化模板,确保项目文档的一致性。通过集中化文档模式,帮助团队在技术审查与系统交接过程中保持清晰的历史背景与运营可见性,有效降低认知负荷。

  • 提供标准化的 ADR 模板,包含决策背景、决策理由、实现说明与影响分析,利于长期架构追踪。

  • 具备运营手册模板,涵盖先决条件、步骤程序、验证方式、回滚策略与疑难排解流程。

  • 系统架构文档模式,捕获高阶概览、组件依赖关系、安全性、性能考量与监控可观测性指标。

  • 针对与工单绑定的知识转移 (KT) 格式,促进复杂实现任务后的背景知识分享。

  • 内置文档检查清单,确保内容质量、正确的标题层级、代码块一致性,并排除敏感安全数据。

  • 当启动新的设计决策、记录基础设施服务或完成开发功能时,应启用此技能。

  • 文档输出会自动分配至特定目录,例如 docs/adr/、docs/runbooks/、docs/architecture/ 与 docs/agent-outputs/technical-docs/。

  • 文件必须遵循定义的命名惯例(如 ADR-XXX-{description}.md 或 KT-{{TICKET_PREFIX}}-XXX-{topic}.md),以确保系统可发现性。

  • 必须遵守所提供的格式与规范,包括 H1-H3 标题层级及 Markdown lint 检查,以维护项目标准。

  • 确保所有架构变更均有对应的 ADR 支持,为数据访问模式、CI 基础设施或安全性实现等系统级变更提供审计追踪。

仓库统计

Star 数
58
Fork 数
14
Open Issue 数
8
主要语言
Shell
默认分支
main
同步状态
空闲
最近同步时间
2026年4月29日 14:15
在 GitHub 查看