SuperAPI AI 工具集

confluence-docs

写作与研究

查看项目

更新于 10-15 20:09

技能介绍

用途:为技术文档提供统一模板,适用于创建架构决策记录(ADR)、运维运行手册、系统架构文档、技术规范和知识转移(KT)文档,以保证文档风格与质量一致。

主要能力:包含多种模板。ADR 模板含状态、背景、决策、后果(正面/负面/中性)、实现说明、相关决策与参考。运行手册模板含概述、前置条件、分步过程、验证、回滚、故障排查、联系人与修订历史。架构文档模板含概述、目标与非目标、架构图、组件、数据流、安全、性能、监控、未来考虑与参考。KT 文档模板含摘要、背景、关键决策、实现细节、注意事项、测试、相关工单与后续工作。还给出文档输出位置与命名规范(如 docs/adr/ADR-XXX-{description}.md),以及发布前的文档检查清单(标题、标题层级、代码块语言标记、相关链接、作者与日期、无敏感数据、拼写检查、Markdown lint 通过)。

使用方式:本技能使用 {{PLACEHOLDER}} 占位符,使用前需替换为项目实际值;按文档类型选择对应模板,放入指定目录并使用规定命名;发布前对照检查清单核对。

适用场景:需要结构化记录技术决策、操作流程、系统架构或交接知识时使用。

限制:未提供自动化生成、验证或发布功能,也未说明支持的平台、收费或价格;模板仅依据给定资料,实际效果取决于占位符替换与人工填写。