技能 documentation-generation-doc-generate
📦
documentation-generation-doc-generate
安全
從程式碼產生完整文件
讓您的文件與程式碼自動保持同步。此技能從原始碼中擷取資訊，以建立 API 規格、架構圖表和隨著程式碼演進而持續更新的使用者指南。
支援: Claude Codex Code(CC)
1
下載技能 ZIP
2
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
3
開啟並開始使用
測試它
正在使用「documentation-generation-doc-generate」。 Analyze Python API routes in src/routes/
預期結果:
- OpenAPI 3.0 specification file (openapi.yaml)
- Interactive API documentation HTML page
- Code examples in Python, JavaScript, and cURL for each endpoint
正在使用「documentation-generation-doc-generate」。 Document the microservices architecture
預期結果:
- System architecture diagram showing service relationships
- Component documentation with technology stacks and responsibilities
- Data flow diagrams for key business processes
安全審計
安全v1 • 2/24/2026
This skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.
2
已掃描檔案
692
分析行數
0
發現項
1
審計總數
未發現安全問題
審計者: claude
品質評分
38
架構
100
可維護性
87
內容
25
社群
100
安全
100
規範符合性
你能建構什麼
API 文件產生
根據程式碼庫註解和路由定義，自動產生 OpenAPI 規格和互動式 API 文件。
架構文件
透過分析匯入、相依性和程式碼結構，建立系統架構圖表和元件文件。
文件管線自動化
設定 CI/CD 工作流程，在每次程式碼提交時重新產生和部署文件，以保持文件同步。
試試這些提示
基本 API 文件
Analyze the Python files in ./src/api/ directory and generate OpenAPI 3.0 specification with all endpoints, request/response schemas, and authentication requirements.
README 產生
Create a comprehensive README.md for this repository including installation instructions, configuration options, usage examples, and contribution guidelines based on the code structure.
架構圖表
Examine the service modules and their imports to create Mermaid diagrams showing system architecture, data flow, and component dependencies.
完整文件套件
Generate complete documentation including API reference, architecture overview, getting started guide, and deployment instructions. Set up a documentation site using the generated artifacts with search functionality.
最佳實務
- 將文件產生作為 CI/CD 的一部分執行，以保持文件與程式碼變更同步
- 包含文件覆蓋率檢查，當覆蓋率低於閾值時使建置失敗
- 審查產生的文件以確保準確性，並在需要的地方加入人員背景說明
避免
- 僅產生一次文件，且隨著程式碼演進從不更新
- 未經人員審查準確性即發布產生的文件
- 在產生的文件中包含敏感資訊，例如 API 金鑰或內部 URL
常見問題
文件產生支援哪些程式語言？
此技能最適用於 Python、JavaScript、TypeScript 和 Go。它可以分析其他語言並使用基於 AST 的文件擷取，但對於較少見的語言支援可能有限。
此技能可以為私人存放庫產生文件嗎？
是的，在能夠存取您存放庫的 Claude Code 或 Codex 中執行時，此技能可以分析並為私人程式碼庫產生文件。
我如何保持產生的文件為最新狀態？
設定一個在程式碼變更時觸發文件重新產生的 CI/CD 工作流程。此技能包含用於自動化文件管線的 GitHub Actions 工作流程範例。
可以產生哪些文件格式？
OpenAPI/Swagger 規格、Markdown 文件、Mermaid 圖表、HTML 文件網站，以及用於 Sphinx 整合的 reStructuredText。
此技能是否取代人類技術撰寫人員？
不會。它會自動化重複性的文件任務並產生參考文件，但人類撰寫人員對於敘事內容、教學課程和確保文件品質仍然至關重要。
產生的文件有多準確？
準確性取決於程式碼品質和註解。具有型別提示和文件字串的妥善記錄程式碼會產生更好的結果。發布前請務必審查產生的文件。