rtgs2017-nagaagent-document-writer.ocm.json json Copy{
"ocm": "1",
"id": "rtgs2017-nagaagent-document-writer",
"kind": "skill",
"name": "document-writer",
"description": "专业文档编写技能。用于撰写技术文档、README、API文档、用户手册等。当用户需要编写或改进文档时使用此技能。",
"publisher": "rtgs2017",
"version": "1.0.0",
"capabilities": {
"domains": [
"general"
],
"tags": [
"skill-md",
"document",
"writing",
"technical",
"skills-sh"
],
"languages": [
"en"
]
},
"quality_prior": 0.6,
"examples": [
"专业文档编写技能。用于撰写技术文档、README、API文档、用户手册等。当用户需要编写或改进文档时使用此技能。"
],
"primary": false,
"metadata": {
"source": {
"provider": "skills.sh",
"repository": "https://github.com/rtgs2017/nagaagent",
"path": "skills/document-writer/SKILL.md",
"ref": "HEAD",
"url": "https://github.com/rtgs2017/nagaagent/blob/HEAD/skills/document-writer/SKILL.md",
"key": "rtgs2017/nagaagent/skills/document-writer/SKILL.md"
}
},
"instructions": "# 文档编写技能\r\n\r\n本技能提供专业的技术文档编写能力。\r\n\r\n## 支持的文档类型\r\n\r\n### 1. README 文档\r\n- 项目简介\r\n- 安装说明\r\n- 快速开始\r\n- 配置选项\r\n- API 参考\r\n- 贡献指南\r\n\r\n### 2. API 文档\r\n- 接口描述\r\n- 请求/响应格式\r\n- 参数说明\r\n- 错误码\r\n- 使用示例\r\n\r\n### 3. 用户手册\r\n- 功能介绍\r\n- 操作步骤\r\n- 常见问题\r\n- 故障排除\r\n\r\n### 4. 技术规范\r\n- 架构设计\r\n- 数据模型\r\n- 流程图\r\n- 接口规范\r\n\r\n## 写作原则\r\n\r\n### 清晰性\r\n- 使用简洁明了的语言\r\n- 避免歧义和模糊表达\r\n- 提供具体示例\r\n\r\n### 完整性\r\n- 覆盖所有必要信息\r\n- 包含先决条件\r\n- 说明边界情况\r\n\r\n### 可用性\r\n- 逻辑结构清晰\r\n- 易于导航\r\n- 提供搜索友好的标题\r\n\r\n## 文档模板\r\n\r\n### README 模板\r\n```markdown\r\n# 项目名称\r\n\r\n简短描述(一句话)\r\n\r\n## 特性\r\n\r\n- 特性 1\r\n- 特性 2\r\n\r\n## 安装\r\n\r\n\\`\\`\\`bash\r\nnpm install xxx\r\n\\`\\`\\`\r\n\r\n## 快速开始\r\n\r\n\\`\\`\\`javascript\r\n// 示例代码\r\n\\`\\`\\`\r\n\r\n## ",
"cost": {
"context_tokens": 197
}
}