SuperAPI AI 工具集

arc42-documentation

写作与研究

查看项目

更新于 10-16 06:44

技能介绍

用途:该技能用于按 arc42 模板创建完整的软件架构文档,适用于架构文档编写、方案规划与设计、以及遵循既有最佳实践的场景。

主要能力:提供 arc42 的 12 个章节结构,包括引言与目标、架构约束、系统范围与上下文、解决方案策略、构建块视图、运行时视图、部署视图、横切概念、架构决策、质量需求、风险与技术债、术语表;并给出各章节的填写要点、表格字段与示例(如质量目标、干系人、约束、接口、质量场景、风险等)。

使用方式:技能要求采用“文档优先”方法——在编写前先调用 docs-management 技能获取架构文档模式,通过 MCP 服务器(perplexity)核实 arc42 当前版本,并以官方 arc42 模板为基础。推荐工作流为:先写上下文(1-3 章),再记录决策(4 章),细化结构(5 章),展示行为(6 章),映射基础设施(7 章),记录模式(8 章),关联 ADR(9 章),定义质量(10 章),说明风险(11 章),统一术语(12 章)。

适用场景:需要标准化架构文档的团队、架构评审、新系统设计或既有系统文档补全。

限制:资料未提供具体安装命令、收费方式、平台支持范围或实际效果数据;部分章节(如运行时视图、质量需求、风险、术语表)为按条件包含,并非所有项目都必须填写。