一個自動化的文檔引擎，可跨多種程式語言生成專業的 README、API 參考與程式碼註釋。
安裝與下載
1. ClawHub CLI
從來源直接安裝技能的最快方式。
npx clawhub@latest install rupert-code-documentor
2. 手動安裝
將技能資料夾複製到以下位置之一
~/.openclaw/skills/ <project>/skills/ 優先級：工作區 > 本地 > 內建
3. 提示詞安裝
將此提示詞複製到 OpenClaw 即可自動安裝。
請幫我使用 Clawhub 安裝 rupert-code-documentor。如果尚未安裝 Clawhub，請先安裝（npm i -g clawhub）。
想要直接下載？
取得包含原生技能檔案的ZIP壓縮檔。
什麼是 Code Documentor Skill？
Code Documentor 技能是任何開發者工具包的重要補充，在 Openclaw Skills 生態系統中提供自動化文檔功能。它透過分析原始碼並生成結構化的 Markdown、HTML 或 PDF 檔案，簡化了創建與維護技術文檔的過程。透過利用先進的 AI 分析，它確保您的程式碼保持清晰、可維護且專業，無需手動操作。
該技能旨在支援包括 Python、JavaScript、Swift 與 Rust 在內的多種語言，幫助團隊保持同步。使用 Openclaw Skills 進行文檔編制意味著遵循最佳實踐，例如包含範例、添加類型提示以及根據特定語言規範（如來自 Google 或 Stripe 的規範）記錄參數。
Code Documentor Skill 應用場景
- 為新專案快速創建 README.md 以改進新成員入職體驗。
- 為 RESTful 端點生成全面的 API 文檔。
- 為現有程式碼庫添加缺失的 docstrings 與函數解釋。
- 為開源貢獻生成架構概述與貢獻指南。
Code Documentor Skill 運作原理
- AI 代理掃描專案目錄或特定的程式碼檔案以解釋邏輯。
- 它映射出函數、參數、回傳類型與類別結構。
- 該技能根據用戶選擇的文檔樣式套用預定義模板。
- 文檔被合成到清晰、易讀的章節，如安裝、用法與 API 參考。
- 最終內容匯出為指定格式，以便在專案中立即使用。
Code Documentor Skill 設定指南
將 Code Documentor 整合到您的 Openclaw Skills 設置中非常簡單。您可以在 CLI 中使用簡單的自然語言指令調用文檔引擎。
# Standard project documentation
openclaw run "document this code"
# Target specific components
openclaw run "create API docs for /v1/auth endpoint"
Code Documentor Skill 資料結構與分類體系
Code Documentor 將輸出數據組織成邏輯段落，以確保高可讀性與 SEO 價值。
| 數據類型 | 描述 | 關鍵要素 |
|---|---|---|
| 專案資訊 | 通用概覽 | 名稱、描述、安裝 |
| API Schema | 端點映射 | 方法、路徑、參數、描述 |
| 邏輯文檔 | 深入程式碼分析 | 函數簽名、參數、回傳值、異常 |
| 結構化文檔 | 專案佈局 | 架構文檔、檔案樹 |
Code Documentor Skill 進階特性
- 可配置的文檔樣式，專為 Google、Stripe 或預設格式定制。
- 支援包括 Go、Java 與 TypeScript 在內的多語言環境。
- 自動生成範例，在生成的文檔中演示程式碼用法。
- 多樣化的輸出選項，為 Git 提供 Markdown，為利益相關者提供 PDF/HTML。
SKILL.md
加載中
Openclaw 相關技能
精選*
