meltemi-q-wechatarticleedittool-document-rule.ocm.json json {
"ocm": "1",
"id": "meltemi-q-wechatarticleedittool-document-rule",
"kind": "skill",
"name": "document",
"description": "description: globs: *.md alwaysApply: false --- # 文档规范",
"publisher": "Meltemi-Q",
"version": "1.0.0",
"capabilities": {
"domains": [
"general"
],
"tags": [
"skill-md",
"github-cursor-rules"
],
"languages": [
"en"
]
},
"quality_prior": 0.6,
"examples": [
"description: globs: *.md alwaysApply: false --- # 文档规范"
],
"primary": false,
"metadata": {
"source": {
"provider": "github-cursor-rules",
"repository": "https://github.com/Meltemi-Q/WechatArticleEditTool",
"path": ".cursor/rules/document.mdc",
"ref": "b96d4b2d5a67fbfd77d49903a4d5e9c8c5c37a50",
"url": "https://github.com/Meltemi-Q/WechatArticleEditTool/blob/b96d4b2d5a67fbfd77d49903a4d5e9c8c5c37a50/.cursor/rules/document.mdc",
"key": "Meltemi-Q/WechatArticleEditTool/.cursor/rules/document.mdc"
}
},
"instructions": "---\r\ndescription: \r\nglobs: *.md\r\nalwaysApply: false\r\n---\r\n# 文档规范\r\n\r\n## 通用要求\r\n- 所有文档使用Markdown格式\r\n- 使用简洁、清晰的语言\r\n- 文档内容应保持最新\r\n- 避免拼写和语法错误\r\n- 使用中文作为主要语言\r\n\r\n## 目录结构\r\n- `README.md`：项目根目录，提供项目概述\r\n- `docs/`：存放详细文档\r\n - `guide/`：使用指南\r\n - `api/`：API文档\r\n - `examples/`：示例代码文档\r\n\r\n## README.md 内容规范\r\n- 项目名称和简短描述\r\n- 技术栈说明\r\n- 项目结构说明\r\n- 使用说明\r\n- 许可证信息\r\n\r\n## 版本记录规范\r\n- 使用 `CHANGELOG.md` 记录版本变更\r\n- 遵循语义化版本（Semantic Versioning）规范\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- 说明代码的预期输",
"cost": {
"context_tokens": 155
}
}