SuperAPI AI 工具集

docs-diagram

数据与分析

查看项目

更新于 10-16 00:29

技能介绍

用途:docs-diagram 是一个跨平台 AI 智能体技能,适用于支持 skills.sh 标准的智能体平台。它通过分析真实代码库生成 Mermaid 图表,用于文档化系统结构。

主要能力:支持四类图表,分别输出到对应文件——er 生成 docs/data-model.md(实体关系图)、arch 生成 docs/architecture.md(系统架构与组件关系)、deployment 生成 docs/deployment.md(部署基础设施与 CI/CD)、security 生成 docs/security.md(安全架构与数据流)。

使用方式:命令形式为 docs-diagram er、docs-diagram arch、docs-diagram deployment、docs-diagram security,可附加可选上下文,如 docs-diagram er for user and order tables。不提供类型时显示可用类型并退出。工作流程包括深度分析代码库、解析参数、并行验证、生成 Mermaid 图、加载模板填充占位符(如 {{PROJECT_NAME}}、{{DATE}}、{{DIAGRAM_CONTENT}})、创建或更新 docs/ 文档并报告结果。

限制与注意:强调防幻觉,图表必须代表真实组件,添加元素前需读取实际文件、确认引用关系、用 find/glob 精确计数,不得包含占位组件,空目录不算组件。文件已存在时覆盖前会询问。图表使用 GitHub 兼容的 Mermaid 语法,并限制复杂度以保证可读性。

适用场景:数据库模式变更、架构演进、部署配置变化、安全架构修改、新成员入职和文档审查时使用。建议在重大变更后重新生成,并人工审查自动生成内容。

资料未提供具体收费、价格、平台兼容细节或效果数据。