前言¶
写技术方案或评审材料时，常见流程是：先通读需求或说明书，再在脑子里拆组件、画层级，最后手工补 Mermaid 或 Visio，并另写一份架构说明。文本里已经写清的边界、依赖和分层，往往还要在图和文档里重复整理一遍，既费时也容易漏项。
下面介绍 SkillHub 上的 软件架构图生成器（@showapi/software-architecture-diagram-generator-showapi）。它面向「已有文字描述、需要结构化架构产出」的场景：把说明书或自由文本交给 Agent 驱动的 Skill，走解析、生成、评审与补全，再落到 Mermaid 代码、设计文档和高清架构图。
这是什么¶
软件架构图生成器 是万维易源在 SkillHub 发布的企业来源 Skill，当前版本 v1.0.0，分类为 dev-programming。
一句话定位：通过输入软件说明书或文本，自动解析架构意图，抽取组件与层级，生成 Mermaid 架构代码，经评审与补全后输出完整架构设计文档，并渲染高清架构图。官方说明中的适用方向包括软件工程文档编写、架构评审、技术方案输出等。
该 Skill 带有 requires_api_key=true 标签，使用前需按 Skill 内说明配置万维易源 ShowAPI 相关密钥；具体字段以安装后的 SKILL.md 为准。
核心功能¶
以下能力均来自 SkillHub 官方简介，未在页面上单独拆步骤的环节，按简介表述归纳：
- 文本输入与意图解析：接受软件说明书或普通文本，对架构意图做结构化理解。
- 组件与层级抽取：从文本中归纳系统组件及其层级关系，为画图和写文档提供骨架。
- Mermaid 架构代码生成：输出可用于渲染的 Mermaid 架构图代码，便于在 Markdown、文档站或支持 Mermaid 的工具中复用。
- 评审与补全：在生成结果基础上做专业向的评审与缺口补全，减少「只有图、没有说明」或「只有罗列、没有分层」的情况。
- 融合输出：合并为完整的架构设计文档，并渲染高清架构图，方便直接放进方案或评审材料。
安装与启用¶
Skill 遵循通用 SKILL.md 格式。在支持 SkillHub 的 Agent 环境中，按官方安装指引操作即可。
1. 安装 SkillHub CLI（如尚未安装）¶
先检查是否已有 skillhub：
command -v skillhub && skillhub --version
若未安装，可使用官方一键脚本（完整安装含 CLI 与默认 Skill）：
curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash
仅安装 CLI 时：
curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash -s -- --cli-only
2. 安装本 Skill¶
官方页面给出的安装提示为：根据 SkillHub 安装文档，安装坐标 @showapi/software-architecture-diagram-generator-showapi。
用 CLI 安装时，必须用 --dir 指向当前 Agent 的 skills 目录，否则默认落在 ./skills/，Agent 可能无法加载。常见路径示例（以你本机实际配置为准）：
- Cursor：
~/.cursor/skills/ - Claude Code：
~/.claude/skills/ - Codex：
~/.codex/skills/或项目下的.agents/skills/
示例命令（将 <skills 目录> 换成上面对应路径）：
skillhub install @showapi/software-architecture-diagram-generator-showapi --dir <skills 目录>
也可在对话中让 AI 按同一文档与坐标完成安装。安装后按 Skill 说明配置 API Key，并重启或刷新 Agent 的技能加载（视你所用客户端而定）。
典型用法¶
官方未提供固定示例项目路径，典型用法与简介一致，可按下面步骤在 Agent 对话中复现：
- 启用已安装的 软件架构图生成器 Skill，并确认 ShowAPI 密钥已配置。
- 粘贴待分析的 软件说明书、PRD 片段、技术方案正文 等；若只有要点列表，也可直接输入，但完整说明书更利于抽取层级与组件。
- 明确要求产出物，例如：Mermaid 架构图代码、架构设计文档章节结构、以及高清架构图（按 Skill 实际输出形式为准）。
- 对生成结果做一轮人工核对：组件命名是否与团队规范一致、边界是否与原文冲突；需要时让 Agent 在同一 Skill 流程下做补全或修订。
经过上面的步骤，你应能得到可粘贴进仓库或 Confluence 的 Mermaid 与文档草稿，再按团队模板微调即可。
适用场景与注意¶
适合谁
- 需要快速把已有文字材料转成 架构图 + 设计说明 的研发、架构师或技术写作角色。
- 架构评审、投标或内部方案中，希望 统一从同一套文本推导图与文档，减少手工重画。
限制与注意
- 依赖 API Key：标签
requires_api_key=true，未配置密钥时无法调用后端能力；密钥与配额以万维易源 ShowAPI 侧规则为准。 - 输入质量：简介强调「深度解析」的前提是输入里确有可抽取的架构信息；过于简略的 bullet 可能仍需你补充上下文或迭代补全。
- 企业来源：Skill 来源标记为 enterprise，安装与使用前请按组织合规要求评估外部 API 与数据出境策略。
- 统计信息：SkillHub 抓取资料中该 Skill 评分为 100000、下载 67777（页面数据会变动，以 SkillHub 实时展示为准）。
结尾¶
若你的工作流经常是「先有一大段说明，再要图和架构文档」，可以把 软件架构图生成器 当作固定 Skill：文本进，Mermaid 与设计文档出，再本地评审定稿。
