| name | document-writer |
| description | 专业文档编写技能。用于撰写技术文档、README、API文档、用户手册等。当用户需要编写或改进文档时使用此技能。 |
| version | 1.0.0 |
| author | Naga Team |
| tags | ["document","writing","technical"] |
| enabled | true |
文档编写技能
本技能提供专业的技术文档编写能力。
支持的文档类型
1. README 文档
- 项目简介
- 安装说明
- 快速开始
- 配置选项
- API 参考
- 贡献指南
2. API 文档
- 接口描述
- 请求/响应格式
- 参数说明
- 错误码
- 使用示例
3. 用户手册
4. 技术规范
写作原则
清晰性
- 使用简洁明了的语言
- 避免歧义和模糊表达
- 提供具体示例
完整性
可用性
文档模板
README 模板
# 项目名称
简短描述(一句话)
## 特性
- 特性 1
- 特性 2
## 安装
\`\`\`bash
npm install xxx
\`\`\`
## 快速开始
\`\`\`javascript
// 示例代码
\`\`\`
## 配置
| 参数 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| ... | ... | ... | ... |
## 许可证
MIT
使用流程
- 确定文档类型和目标读者
- 收集必要信息
- 按模板结构组织内容
- 审查和优化表达
- 添加示例和图表