SuperAPI AI 工具集

architecture-documentation

办公与效率

查看项目

更新于 10-16 00:23

技能介绍

用途:该技能用于为系统生成架构文档,覆盖 C4 图(Context 上下文、Container 容器、Component 组件)、不同干系人视角文档,以及技术概览或执行摘要。

主要能力:提供六种文档类型,分别面向不同受众——Context(所有干系人,描述系统边界与外部交互)、Container(技术负责人,服务、数据库与主要组件)、Component(开发者,容器内部结构)、Deployment(运维,基础设施与环境)、Data(数据架构师,数据流、存储与模式)、Executive Summary(管理层,业务价值与关键决策)。文档遵循统一模板结构:标题/版本/日期/作者、概述、图示、组件详情、关联 ADR 的决策、参考链接。

使用方式:生成前先分析代码库,确定范围(单服务、多服务或整体系统),查找现有文档与关键架构文件(配置、部署规格);再按受众、目的和范围选择文档类型;然后按标准结构生成。若可视化插件可用,调用 visualization:diagram-generator agent 生成对应 C4 图并将 Mermaid/PlantUML 代码嵌入文档;若不可用,则退化为文本描述并注明可通过插件补充图示。生成的文档建议放置于 /architecture/viewpoints/ 下,含 context.md、containers.md、components/[container-name].md、executive-summary.md。

与其他技能协作:可与 adr-management 关联 ADR、与 togaf-guidance 对齐 ADM 阶段、与 zachman-analysis 保证视角覆盖。

限制:需要先完成代码库分析并明确范围;图示集成依赖可视化插件是否可用;完成前需检查完整性清单(范围、主要组件、外部依赖、ADR 关联、图文一致、受众语言、版本日期)。以上为资料所述内容,价格与具体平台支持等未在资料中提供。