前言¶
寫技術方案或評審材料時，常見流程是：先通讀需求或說明書，再在腦子裏拆組件、畫層級，最後手工補 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 與設計文檔出，再本地評審定稿。
