前言¶

接手存量項目時，常見情況是：代碼和界面能跑，但 BRD、PRD、設計說明、測試用例、運營手冊要麼沒有，要麼和當前實現不一致。人工從倉庫和 UI 裏梳理業務邏輯再按各文檔模板重寫，耗時長，且不同人寫的章節結構、分析視角容易不統一。

下面介紹 SkillHub 上的社區 Skill「從代碼和 UI 逆向提取業務邏輯文檔」（座標 @user_35d642b5/code-to-doc-generator，版本 1.0.0）。它的思路是：在 Agent 讀取代碼與 UI 的前提下，按 Skill 內約束的寫作維度與格式規範，生成或更新多種類型的項目文檔，並支持用自然語言觸發「逆向分析」「同步文檔」「文檔漂移」等維護動作。

這是什麼¶

一句話定位：面向任意項目類型（Web、後端服務、移動端、桌面應用等），從代碼與 UI 反向歸納業務邏輯，並輸出多類標準化文檔的 Agent Skill。

維護與分發：由 SkillHub 社區發佈者 user_35d642b5 提供，分類爲 dev-programming，來源標記爲 community。SkillHub 頁面顯示該 Skill 評分爲 100000、下載 2654 次；標籤標明 requires_api_key=false，安裝使用本身不依賴額外 API Key 配置。

它解決的核心問題是：在缺少或過時文檔時，用同一套分析視角把「實現裏真實存在的業務」落到 BRD/MRD、PRD、概要/詳細設計、測試與運維類文檔上，減輕文檔漂移和手工對齊成本。

核心功能¶

以下能力均來自 SkillHub 官方簡介與頁面說明，可按文檔類型與觸發詞在對話中選用。

文檔類型¶

Skill 聲明可生成或完善的項目文檔包括：

• 需求與商業類：BRD、MRD、PRD
• 設計類：HLD 概要設計、DDD 領域設計、LLD 詳細設計、編碼指南
• 測試類：BDD / SIT / E2E / UAT 等測試文檔
• 運營與工程類：運營手冊、操作指南、SLI/SLO 監控文檔、CI/CD 文檔

寫作約束¶

簡介中強調：會約束文檔的寫作維度、分析視角和格式規範，而不是隻輸出一段自由發揮的說明。具體章節模板與檢查項寫在 Skill 自帶的 SKILL.md 及引用材料中，由 Agent 在安裝後按 Skill 規範執行。

觸發方式¶

官方列出的觸發詞包括：生成文檔、業務文檔、運營手冊、操作指南、需求文檔、PRD、BRD、MRD、概要設計、HLD、詳細設計、LLD、DDD、領域設計、測試文檔、編碼指南、逆向分析、完善文檔、更新手冊、同步文檔、文檔漂移、反向同步。在已啓用該 Skill 的 Agent 會話裏，用上述詞組說明目標文檔類型與範圍即可喚起對應流程。

安裝與啓用¶

Skill 基於通用 SKILL.md 格式。官方頁面給出的安裝指引是：讓 Agent 依照 SkillHub 安裝說明 安裝座標 @user_35d642b5/code-to-doc-generator。

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 到當前 Agent 的 skills 目錄¶

安裝文檔要求：必須用 --dir 指向當前 Agent 識別的 skills 目錄，否則默認裝到 ./skills/ 可能不會被加載。

skillhub install user_35d642b5/code-to-doc-generator --dir <skills 目錄>

常用客戶端的 skills 路徑（摘自官方安裝文檔）：

• Cursor：~/.cursor/skills/
• Claude Code：~/.claude/skills/
• Codex：~/.codex/skills/ 或項目下的 .agents/skills/

也可將下面提示詞發給支持 Skill 的 AI，由其按安裝文檔完成安裝：

請根據 https://skillhub.cn/install/skillhub.md，安裝 `@user_35d642b5/code-to-doc-generator`。

安裝後按你所用客戶端的要求重啓或刷新 Agent，使 Skill 生效。

典型用法¶

官方頁面未提供單獨的業務案例倉庫；可復現的用法是：在已打開目標項目的工作區中啓用 Skill，用觸發詞說明文檔類型、範圍與輸出位置。下面步驟與官方能力描述一致，便於自行驗證。

1、在 Cursor（或其他已配置 skills 目錄的 Agent）中打開待分析的項目倉庫，確認 @user_35d642b5/code-to-doc-generator 已安裝到對應 skills 目錄。

2、在對話中明確文檔類型與素材範圍，例如：

逆向分析當前項目，生成 PRD：覆蓋用戶註冊與登錄模塊，依據後端 API 與前端頁面實現，按 Skill 規定的 PRD 格式輸出到 docs/prd-login.md。

3、若要補齊設計或測試文檔，可換用對應觸發詞：

根據現有代碼生成 HLD 概要設計，說明服務邊界與主要數據流。

完善文檔：對照當前實現更新運營手冊中的部署與回滾步驟，處理文檔漂移。

4、生成後由人工評審：Skill 輸出的是基於代碼與 UI 的歸納，權限邊界、合規表述、未實現需求等仍需團隊確認，不宜直接當作對外正式基線而不審閱。

適用場景與注意¶

適合誰

• 維護存量系統、文檔缺失或嚴重過時的開發、架構或 QA 同學
• 需要在較短時間內補齊 PRD、設計說明、測試說明、運營/CI 文檔清單的團隊
• 希望多種文檔在結構、視角上保持一致、減少「每人一套模板」的情況

使用上需注意

• 逆向文檔反映的是當前實現；若代碼本身存在臨時方案或技術債，文檔會如實體現，不能替代產品決策。
• 大倉庫應縮小模塊範圍（目錄、服務名、功能點），否則單次上下文可能無法覆蓋全部邏輯。
• SkillHub 統計爲社區 Skill（下載 2654、安裝數在 API 側可能爲 0），升級與問題反饋需通過 SkillHub 頁面與發佈者渠道，本文不臆測 SLA 或企業支持。
• 未在官方說明中要求 API Key；若你本地 Agent 另有模型或工具鏈配置，與 Skill 本身無關。

結尾¶

「從代碼和 UI 逆向提取業務邏輯文檔」把「讀代碼 + 讀 UI → 按類型寫規範文檔 → 後續同步防漂移」收斂成一條可在 Agent 裏重複執行的 Skill 路徑，適合作爲存量項目文檔建設的起點，而不是終點——審閱與產品對齊仍不可省略。

官方 SkillHub 頁面：https://www.skillhub.cn/skills/user_35d642b5/code-to-doc-generator
API 元數據地址：https://api.skillhub.cn/user_35d642b5/code-to-doc-generator