documentation
建立專業 API 文件和技術指南
也可从以下获取: Joseph OBrien,sickn33,CrazySwami,BfdCampos,DaoThiHuong2111
撰寫優質文件需要大量的努力和專業技術。此技能提供經過驗證的範本、模式和最佳實踐，用於建立 API 文件、變更日誌、遷移指南、架構決策記錄以及開發人員喜愛使用的技術文件。
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation”。 Create a changelog for these commits: 'feat: add user authentication', 'fix: resolve login timeout bug', 'feat: add password reset flow', 'perf: improve database query performance'
预期结果:
- **新功能**
- - 具有安全登入和會話管理的使用者驗證系統
- - 用於帳戶恢復的密碼重設流程
- **錯誤修復**
- - 修復登入時的超時問題
- **改進**
- - 更快資料庫查詢以提高回應時間
安全审计
安全Pure documentation skill containing only markdown templates and best practice guidelines. No executable code, network calls, file system access, environment variable reads, or command execution. Contains only static documentation content for API docs, technical writing patterns, and documentation templates.
质量评分
你能构建什么
API 文件
建立 OpenAPI 規範、SDK 文件和互動式 API 指南，包含多種語言的範例
用戶指南和手冊
撰寫清晰的用戶指南、教學課程和 README 文件，遵循既定的技術寫作模式
架構文件
記錄設計決策、建立 ADR 並為相關者製作技術設計規格
试试这些提示
Create an OpenAPI 3.0 specification for the following REST API endpoints: [list endpoints with methods and descriptions]
Create a user-friendly changelog from these git commits: [paste commit messages]. Group changes by category: features, improvements, bug fixes, and breaking changes.
Create a migration guide for upgrading from version [old] to [new]. Include breaking changes, code examples before and after, and step-by-step upgrade steps.
Create an Architecture Decision Record for [decision topic]. Include context, problem statement, considered options, chosen solution, and expected consequences.
最佳实践
- 包含實際可運作的程式碼範例，而非佔位符，以幫助使用者理解實作方式
- 在記錄成功場景的同時一併記錄錯誤情況和回應，以實現完整的 API 覆蓋
- 使用目錄和交叉參考以清晰的層級結構組織文件
避免
- 在面向一般使用者寫作時使用技術術語而不加以解釋
- 在程式碼完成後才撰寫文件，而非在開發過程中進行
- 在面向用戶的變更日誌中包含內部重構提交
常见问题
哪些 AI 工具支援此技能？
支援哪些文件格式？
此技能會存取我的 git 儲存庫嗎？
使用此技能時我的資料安全嗎？
此技能可以驗證我的 API 規範嗎？
這與其他文件工具有何不同？
开发者详情
许可证
MIT
引用
main