SuperAPI AI 工具集

arc42-documentation

写作与研究

查看项目

更新于 10-16 02:39

技能介绍

用途:按照 arc42 标准模板生成完整、结构化的软件架构文档,适用于新项目立项、遗留系统补档、面向不同技术背景干系人的架构总览、认证(如 iSAQB)准备,以及跨项目统一文档标准。

主要能力:arc42 模板含 12 个章节——1 引言与目标、2 约束、3 上下文与范围、4 解决方案策略、5 构建块视图、6 运行时视图、7 部署视图、8 横切概念、9 架构决策、10 质量需求、11 风险与技术债、12 术语表。技能要求用 todo 工具跟踪进度,优先使用 search/、read/、edit/* 工具而非终端命令操作文件,文档生成到 docs/architecture/arc42/ 目录,并更新 docs/architecture.md 索引,同时要求为上下文、构建块、部署等绘制 Mermaid 图,并在第 9 章引用已有 ADR。

使用方式:先确认文档范围(整体系统还是子系统、是否需要引用 ADR、详细程度、主要干系人),再从 templates/arc42-template.md 生成定制文档,按推荐顺序填写核心章节(1、3、4、5),补充图表,链接 ADR,校验完整性,更新索引,最后提交(git add docs/architecture/arc42/ docs/architecture.md 与 git commit -m "docs: add arc42 architecture documentation")。

限制:不得逐字复制 arc42 帮助文本,不得与已有 ADR 重复,不得编造需求、约束、质量目标或技术细节,信息不完整时先向用户澄清;所有章节须填写或标记为 TBD/Not Applicable;不适用于琐碎功能,此类应改用普通 ADR;arc42 不能替代代码级文档;文件编辑不应用终端命令或 sed/awk;缺少信息处按资料应标记 TBD,资料未提供具体价格或平台限制。