documentation-templates
快速创建专业文档
此技能提供即用型模板，用于 README 文件、API 文档、代码注释、变更日志和 AI 友好的文档格式。
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation-templates”。 使用 documentation-templates 为 Node.js API 创建 README
预期结果:
完整的 README.md，包含章节：标题 + 一句话概述、快速开始、功能、配置表、API 参考链接、贡献指南、许可证
正在使用“documentation-templates”。 使用 documentation-templates 记录 GET /users 端点
预期结果:
API 文档，包含端点描述、参数表（id: string, required）、响应代码（200, 404）和请求/响应示例
正在使用“documentation-templates”。 使用 documentation-templates 为数据库选择创建 ADR
预期结果:
ADR 文档，包含状态（Accepted/Deprecated/Superseded）、上下文（为什么需要此决策）、决策（决定了什么）、后果（权衡）
安全审计
安全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 代理集成
创建 AI 代理（如 Claude 和 Codex）能够理解并有效使用的文档。
试试这些提示
使用 documentation-templates 技能为我的 [project type] 项目创建 README.md。包含快速开始、功能和配置章节。
使用 documentation-templates 技能为我的 REST API 创建 API 文档，包含 [list endpoints] 端点。
使用 documentation-templates 技能为我的函数添加 JSDoc 注释，该函数 [describe function purpose]。
使用 documentation-templates 技能为 [decision title] 创建 ADR。包含上下文、决策和后果章节。
最佳实践
- 先添加基本章节（标题、快速开始、功能），然后再添加详细文档
- 将模板作为起点，根据项目需求调整结构
- 保持文档最新——过时的文档比没有文档更糟糕
- 在文档中包含示例，帮助用户快速理解
避免
- 不要直接复制模板而不根据项目上下文进行定制
- 避免在面向用户的 README 文件中记录实现细节
- 不要跳过快速开始章节——用户想要快速上手
- 避免使用 AI 代理无法解析的过时文档格式