技能 Reference Builder
📦
Reference Builder
安全
生成全面的 API 和技術文件
手動建立詳盡的技術文件既耗時又容易出錯。此技能可自動生成完整的參考資料，並保持一致的格式和全面的參數涵蓋。
支援: Claude Codex Code(CC)
1
下載技能 ZIP
2
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
3
開啟並開始使用
測試它
正在使用「Reference Builder」。 記錄 REST API 端點：POST /api/users，參數：name (string, required), email (string, required), age (integer, optional)
預期結果:
- ### POST /api/users
- **描述**：在系統中建立新的使用者帳戶。
- **參數**：
- - `name` (string, required)：使用者全名，2-100 個字元
- - `email` (string, required)：有效的電子郵件地址，必須唯一
- - `age` (integer, optional)：使用者年齡，18-120 歲
- **回傳**：包含 id、name、email、created_at 的使用者物件
- **錯誤**：400 (驗證)、409 (重複電子郵件)、500 (伺服器錯誤)
- **範例**：
- POST /api/users
- {"name": "Jane Doe", "email": "jane@example.com", "age": 30}
正在使用「Reference Builder」。 記錄資料庫 User 結構描述，欄位：id、username、email、created_at、status
預期結果:
- ### User 結構描述
- | 欄位 | 型別 | 限制 | 描述 |
- |-------|------|-------------|-------------|
- | id | UUID | PRIMARY KEY | 唯一識別碼 |
- | username | VARCHAR(50) | NOT NULL, UNIQUE | 使用者顯示名稱 |
- | email | VARCHAR(255) | NOT NULL, UNIQUE | 聯絡電子郵件地址 |
- | created_at | TIMESTAMP | NOT NULL, DEFAULT NOW() | 帳戶建立時間 |
- | status | ENUM | NOT NULL, DEFAULT 'active' | 帳戶狀態：active、suspended、deleted |
- **索引**：username_idx、email_idx、status_idx
- **關聯性**：與 Posts 一對多，與 Profile 一對一
安全審計
安全v1 • 2/24/2026
This is a prompt-only skill containing no executable code. Static analysis scanned 0 files with 0 lines of code and detected no security patterns. The skill consists entirely of documentation instructions and prompt templates for creating technical references.
0
已掃描檔案
0
分析行數
0
發現項
1
審計總數
未發現安全問題
審計者: claude
品質評分
38
架構
100
可維護性
87
內容
31
社群
100
安全
74
規範符合性
你能建構什麼
API 參考產生
為內部或公開 API 建立全面的 API 文件，包含完整的參數列表、回傳型別、錯誤碼和使用範例。
設定文件
為複雜應用程式產生詳細的設定指南，記錄所有設定、預設值、限制和特定環境的值。
SDK 文件
產生詳盡的 SDK 參考資料，包含類別階層、方法簽名、型別定義和整合範例。
試試這些提示
基本 API 方法文件
將以下 API 端點記錄為完整的參考條目。包含方法簽名、所有參數的型別和限制、回傳值、可能的錯誤和基本使用範例： 端點：[METHOD] [URL] 參數：[list parameters] 情境：[describe what it does]
設定參數參考
為以下設定建立全面的設定參考表格。針對每個參數，記錄型別、預設值、有效範圍、是否為必要、環境變數名稱，以及與其他設定的任何相依性： [提供設定參數列表]
帶有範例的結構描述文件
為以下資料模型產生完整的結構描述文件。包含欄位型別、驗證規則、限制、與其他模型的關聯性、索引資訊，並提供三個範例：最簡有效記錄、完整填滿的記錄和邊緣案例： [提供結構描述定義]
完整模組參考指南
為以下模組建立完整的技術參考。結構包含：1) 解釋目的的概述區段，2) 所有公開方法的快速參考表格，3) 每個方法的詳細條目，包含簽名、參數、回傳型別、錯誤和範例，4) 相關方法之間的交叉參照，5) 效能考量，以及 6) 應避免的常見陷阱： [提供模組原始碼或介面定義]
最佳實務
- 記錄行為和意圖，而非實作細節 - 專注於程式碼做什麼，而非如何做
- 同時包含順利路徑範例和錯誤處理情境，以達成全面涵蓋
- 在所有文件中使用一致的術語 - 建立並遵循用語表
避免
- 撰寫省略錯誤處理的範例 - 務必展示如何處理失敗
- 使用實作特定的術語，而非清晰、以使用者為導向的語言
- 建立沒有版本標記的文件 - 務必指出每個功能適用的版本
常見問題
此技能可以產生哪些類型的文件？
此技能可產生 API 參考、設定指南、結構描述文件、疑難排解指南、移轉指南和完整的模組參考。涵蓋任何需要詳盡參數列表和結構化格式的技術文件。
我需要提供原始碼才能進行文件化嗎？
是的，此技能需要您提供想要進行文件化的原始碼、API 規格或結構描述定義。它無法自動從您的程式碼庫擷取文件 - 您必須提供要進行文件的材料。
產生的文件準確度如何？
文件的準確性取決於您來源材料的完整性。請務必針對實際實作驗證產生的文件，特別是用於生產環境的關鍵 API 或設定指南。
此技能可以記錄多種程式語言嗎？
是的，此技能與程式語言無關，無論程式語言為何，都可以記錄 API、設定和結構描述。它專注於介面文件，而非特定語言的實作細節。
此技能支援 OpenAPI 或 Swagger 規格嗎？
此技能可以將 OpenAPI 規格作為來源材料，並能以與 OpenAPI 慣例相容的格式產生文件。然而，它不會自動解析 OpenAPI 檔案 - 您必須提供相關的規格詳細資訊。
我應該如何處理已棄用功能的文件？
為每個已棄用的功能包含「已棄用」區段，指定棄用的版本、建議的替代方案和移轉時程。此技能將根據標準條目格式格式化這些內容，並提供明確的移轉指導。