documentation-templates
快速建立專業文件
此技能提供現成可用的模板，包括 README 檔案、API 文件、程式碼註解、變更紀錄，以及 AI 友善的文件格式。
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「documentation-templates」。 Use documentation-templates to create a README for a Node.js API
預期結果:
完整的 README.md，包含章節：標題 + 單句描述、快速開始、功能、設定表格、API 參考連結、貢獻指南、授權
正在使用「documentation-templates」。 Use documentation-templates to document a GET /users endpoint
預期結果:
API 文件，包含端點描述、參數表格（id: string，必��）、回應代碼（200、404），以及範例請求/回應
正在使用「documentation-templates」。 Use documentation-templates to create an ADR for database choice
預期結果:
ADR 文件，包含狀態（已接受/已棄用/已取代）、脈絡（為何需要此決策）、決策（做了什麼決定）、後果（取捨）
安全審計
安全All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.
偵測到的模式
品質評分
你能建構什麼
新專案設置
使用 README、API 文件與變更紀錄模板，快速為新專案搭建文件架構。
文件標準化
使用標準化模板，在團隊專案間維持一致的文件風格。
AI Agent 整合
建立 Claude 與 Codex 等 AI agent 能有效理解與使用的文件。
試試這些提示
Use the documentation-templates skill to create a README.md for my [project type] project. Include Quick Start, Features, and Configuration sections.
Use the documentation-templates skill to create API documentation for my REST API with endpoints for [list endpoints].
Use the documentation-templates skill to add JSDoc comments to my function that [describe function purpose].
Use the documentation-templates skill to create an ADR for [decision title]. Include Context, Decision, and Consequences sections.
最佳實務
- 在新增詳細文件之前，先從重要章節開始（標題、快速開始、功能）
- 將模板視為起點，並根據專案需求調整結構
- 保持文件更新—過期的文件比沒有文件更糟
- 在文件中加入範例，幫助使用者快速理解
避免
- 不要未經自訂就逐字複製模板，應根據專案脈絡調整
- 避免在使用者面向的 README 檔案中記錄實作細節
- 不���跳過快速開始章節—使用者想要快速開始使用
- 避免使用 AI agent 無法剖析的過時文件格式