Getting it into your agent
It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.
git clone --depth 1 https://github.com/Mr-chen-05/rules-2.1-optimized-zhnpx agentmods add rules/mr-chen-05/rules-2.1-optimized-zh/create-docsWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/rules/mr-chen-05/rules-2.1-optimized-zh/create-docs)<a href="https://agentmods.dev/rules/mr-chen-05/rules-2.1-optimized-zh/create-docs"><img src="https://agentmods.dev/badge/rules/mr-chen-05/rules-2.1-optimized-zh/create-docs/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/rules/mr-chen-05/rules-2.1-optimized-zh/create-docs"><img src="https://agentmods.dev/badge/rules/mr-chen-05/rules-2.1-optimized-zh/create-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00000 | $0.01452 |
| Opus 5.5 | $0.00000 | $0.00581 |
| Sonnet 5.5 | $0.00000 | $0.00290 |
| Haiku 4.5 | $0.00000 | $0.00145 |
Grade A, and why
create-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 221 lines — stays where its author put it; the contents beside it link to each section on GitHub.
📝 Documentation Creation - 文档创建
生成全面、结构化的项目文档。
🚀 Commands - 命令
/create-docs- 创建完整文档/api-docs- 生成API文档/user-guide- 创建用户指南/dev-docs- 开发者文档
📋 Process - 文档流程
1. 📊 文档规划 (Documentation Planning)
- 分析目标受众和使用场景
- 确定文档结构和内容范围
- 选择合适的文档工具和格式
- 转换条件：文档规划完整，结构清晰
2. ✍️ 内容创建 (Content Creation)
- 编写核心文档内容
- 添加代码示例和截图
- 创建图表和流程图
- 转换条件：内容完整，质量达标
3. 🔍 审查优化 (Review & Optimization)
- 检查内容准确性和完整性
- 优化文档结构和可读性
- 添加导航和索引
- 转换条件：文档质量优秀，用户友好
4. 🚀 发布维护 (Publish & Maintain)
- 发布到文档平台
- 设置自动更新机制
- 收集用户反馈
- 转换条件：文档发布成功，维护机制完善
📚 Documentation Types - 文档类型
用户文档 (User Documentation)
- README - 项目概述和快速开始
- 用户指南 - 详细使用说明
- FAQ - 常见问题解答
- 教程 - 分步骤学习指南
开发者文档 (Developer Documentation)
- API文档 - 接口规范和示例
- 架构文档 - 系统设计和结构
- 贡献指南 - 开发参与规范
- 部署指南 - 环境配置和部署
技术文档 (Technical Documentation)
- 设计文档 - 技术方案和决策
- 测试文档 - 测试策略和用例
- 运维文档 - 监控和故障处理
- 变更日志 - 版本更新记录
🛠️ Documentation Tools - 文档工具
静态站点生成器
- VitePress - Vue生态文档工具
- Docusaurus - React生态文档平台
- GitBook - 在线文档协作
- Notion - 团队知识库
API文档工具
- Swagger/OpenAPI - REST API文档
- GraphQL Playground - GraphQL API文档
- Postman - API测试和文档
- Insomnia - API设计和测试
图表工具
- Mermaid - 代码化图表
- Draw.io - 在线图表编辑
- PlantUML - UML图表生成
- Excalidraw - 手绘风格图表
📋 Documentation Template - 文档模板
README模板
# 项目名称
简短的项目描述
## 🚀 快速开始
### 安装
\`\`\`bash
npm install
\`\`\`
### 使用
\`\`\`bash
npm start
\`\`\`
## 📚 文档
- [用户指南](./docs/user-guide.md)
- [API文档](./docs/api.md)
- [开发指南](./docs/development.md)
## 🤝 贡献
请阅读 [贡献指南](./CONTRIBUTING.md)
## 📄 许可证
[MIT](./LICENSE)
API文档模板
# API文档
## 认证
所有API请求需要包含认证头：
\`\`\`
Authorization: Bearer <token>
\`\`\`
## 端点
### GET /api/users
获取用户列表
**参数：**
- `page` (number) - 页码，默认1
- `limit` (number) - 每页数量，默认10
**响应：**
\`\`\`json
{
"data": [...],
"total": 100,
"page": 1
}
\`\`\`
✅ Best Practices - 最佳实践
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 1mo ago First seen · 221 lines · 0 tokens per session scan A 2bb67375527c
create-docs is a cursor rule published in the GitHub repository Mr-chen-05/rules-2.1-optimized-zh (29 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,452 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.
Other cursor rules, from other repositories
ponytail
Ponytail, lazy senior dev mode. Always pick the simplest solution that works.
angular-20
This rule provides comprehensive best practices and coding standards for Angular development, focusing on modern TypeScript, standalone components, signals, and performance optimizations.
dev-standard
Apache Superset development standards and guidelines for Cursor IDE.
prefer-direct-imports-over-module-mocks
Prefer extracting a testable core over vi.mock / vi.resetModules when unit tests need to reach production logic entangled with config, env, or singletons.
config-validation-and-normalization
Config validation and normalization responsibilities (defineConfig normalizes, the orm section schema validates and resolves paths, the loader reports per-section diagnostics).
control-plane-descriptors
Control plane descriptor and instance implementation patterns.