文档生成
- 作者仓库星标 8,868
- 作者更新于 实时读取
- 作者仓库 CRMEB
- 领域
- 文档
- 兼容 Agent
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- 信任分
- 88 / 100 · 社区维护
- 作者 / 版本 / 许可
- @crmeb · 未声明 license
- Token 消耗评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部 API Key
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 底层运行要求
- 无特殊要求
- 文件与系统权限
-
- 只读
- 允许写入 / 修改
- 网络行为
- 仅限本地
- 安装命令数
- 26 条
档案由构建时根据 SKILL.md 与安装命令自动衍生,可能与作者实际意图存在差异。
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: dev-docs-generate
description: 开发文档生成规范,快速生成开发文档,自动放到docs目录下,方便技术快速了解项目,能快速入手开发 public function getUserInfo($id) { return $this…
category: 文档
runtime: 无特殊运行时
---
# dev-docs-generate 输出预览
## PART A: 任务判断
- 适用问题:PRD、RFC、README、项目说明或知识库整理。
- 输入要求:目标材料、限制条件、期望输出和验收方式。
- 证据边界:围绕“0. 自动调用场景 / 0.1 触发条件 / 0.2 适用文件类型”读取原文规则,不把推断写成作者承诺。
## PART B: 执行结果
- **01** 任务判断:确认你的需求是否属于PRD、RFC、README、项目说明或知识库整理,并标出输入、限制和预期结果。
- **02** 执行计划:优先按“0. 自动调用场景 / 0.1 触发条件 / 0.2 适用文件类型”拆成步骤,说明每一步会读取什么、修改什么、产出什么。
- **03** 交付结果:给出可复制的命令、文件改动、检查清单或内容草稿,并说明如何继续迭代。
- **04** 风险边界:结合 读取文件、写入/修改文件、主要在本地完成、通常不需要额外 API Key 给出执行前确认项。
## Running Rules
- 读取文件、写入/修改文件;主要在本地完成;通常不需要额外 API Key。
- 先小样例验证,再放大到真实任务。
- 交付时同时给结果、检查口径和下一步迭代建议。 先确认触发方式
原文没有稳定的斜杠命令要求。安装验证后通常全局生效,直接在对话里点名这个 Skill 并描述任务即可。
给清楚输入和边界
告诉 Agent 目标文件或材料、期望结果、不可改范围、是否允许联网或执行命令。本 Skill 的权限画像是:读取文件、写入/修改文件。
小样例验证后再放大
先用一个小任务确认它会围绕“0. 自动调用场景 / 0.1 触发条件 / 0.2 适用文件类型”工作;涉及文件或命令时,先看 diff、日志、预览或测试结果。
复核后再交付
检查最终产物是否包含明确结果、必要证据和下一步动作;如果输出泛泛而谈,就补充输入、边界和验收标准后重跑。
---
name: dev-docs-generate
description: 开发文档生成规范,快速生成开发文档,自动放到docs目录下,方便技术快速了解项目,能快速入手开发 public function getUserInfo($id) { return $this…
category: 文档
source: crmeb/CRMEB
---
# dev-docs-generate
## 什么时候使用
- 把项目文档方向的常用动作沉淀成 Agent 可调用的技能 适合处理README、PRD、RFC、教程和知识库文档,核心价值是把输入、判断、执行、验证和交付边界固定下来,避免 Agent 泛泛回答。 把任务拆成可执行、可检查、可继续迭代的…
- 面向PRD、RFC、README、项目说明或知识库整理,优先处理能明确输入、步骤和验收标准的工作。
## 需要提供什么
- 目标材料、目录范围、期望结果和不可改动内容。
- 是否允许联网、执行命令、读写文件或调用外部服务。
## 执行规则
- 围绕「0. 自动调用场景 / 0.1 触发条件 / 0.2 适用文件类型」组织步骤,不把推断写成作者事实。
- 读取文件、写入/修改文件;主要在本地完成;通常不需要额外 API Key。
- 先跑小样例,确认结果可检查后再扩大任务范围。
## 输出要求
- 给出最终产物、关键证据、验证方式和下一步动作。
- 信息不足时标记 unknown,不编造命令、平台或依赖。 证据边界与执行链路
作者原文负责流程事实;仓库文件负责来源和命令;流狐只补充适用场景、限制和质量判断。
skill "dev-docs-generate" {
输入层 -> 用户目标 + 目标文件 + 禁止范围 + 验收标准
上下文层 -> 0. 自动调用场景 / 0.1 触发条件 / 0.2 适用文件类型
规则层 -> SKILL.md 触发条件 / 执行顺序 / 输出格式
运行层 -> 无特殊运行时 | 读取文件、写入/修改文件 | 主要在本地完成
安全层 -> 通常不需要额外 API Key + 小任务验证 + diff / 日志复核
输出层 -> 可复制结果 + 检查清单 + 下一步迭代
} CRMEB 项目文档写作规范
0. 自动调用场景
0.1 触发条件
- 目录浏览时:当浏览文档相关目录时自动调用
- 打开
dev-docs/目录时触发 - 打开
dev-docs/phpapi/目录时触发 - 打开
dev-docs/admin/目录时触发 - 打开
dev-docs/uniapp/目录时触发 - 打开
dev-docs/nuxt/目录时触发
- 打开
- 文档创建时:当创建新的 Markdown 文档文件时自动调用
- 文档编辑时:当编辑现有文档文件时自动调用
- 关键词触发:当文档内容包含以下关键词时自动调用
文档、说明、指南、手册、规范API、接口、部署、开发、需求
0.2 适用文件类型
.md(Markdown 文件).txt(文本文件).doc/.docx(Word 文档).pdf(PDF 文档)
0.3 调用优先级
- 当多个技能同时触发时,文档规范技能优先级中等
- 仅在文档相关操作时被触发
- 不影响其他技能的正常使用
1. 文档类型
1.1 技术文档
- API 文档:接口设计、参数说明、返回格式
- 开发文档:架构设计、模块说明、开发流程
- 部署文档:环境要求、安装步骤、配置说明
- 接口文档:接口列表、请求参数、返回示例
1.2 业务文档
- 需求文档:功能描述、业务流程、数据结构
- 测试文档:测试用例、测试结果、缺陷报告
- 用户手册:功能介绍、操作指南、常见问题
2. 格式规范
2.1 文件名规范
- 使用小写下划线分隔
- 清晰描述文档内容
- 示例:
api接口文档.md、部署指南.md
2.2 标题层级
- 使用
#表示标题层级 - 一级标题:文档主题
- 二级标题:主要章节
- 三级标题:细分内容
- 最多使用四级标题
2.3 文本格式
- 正文使用宋体/无衬线字体,14px
- 代码块使用 ``` 包裹,指定语言
- 列表使用
-或1.表示 - 强调内容使用
**加粗**或*斜体*
2.4 代码规范
- 代码块必须指定语言
- 缩进一致,格式清晰
- 关键代码添加注释
- 示例:
// 获取用户信息 public function getUserInfo($id) { return $this->where('id', $id)->find(); }
2.5 文档存放目录
- 文档保存到
dev-docs目录中 - 后端接口文档存放
dev-docs/phpapi目录中 - 后端前端 ElementUI(Admin)文档存放
dev-docs/admin目录中 - 移动端前端 UniApp(移动端)文档存放
dev-docs/uniapp目录中 - PC 端 Nuxt(PC)文档存放
dev-docs/nuxt目录中
3. 内容要求
3.1 结构清晰
- 引言:文档目的、适用范围
- 主体:详细内容,逻辑连贯
- 结论:总结、后续计划
- 附录:参考资料、术语表
3.2 语言要求
- 使用简洁、准确的语言
- 避免歧义,术语统一
- 中文文档使用规范汉字
- 英文文档语法正确
3.3 内容完整性
- 包含必要的背景信息
- 步骤清晰,可操作
- 提供示例和截图
- 注明版本和更新日期
3.4 可维护性
- 定期更新,保持时效性
- 使用版本控制管理文档
- 注明作者和联系方式
- 便于搜索和导航
4. 文档工具
4.1 编辑工具
- 推荐使用 Markdown 格式
- 支持工具:VS Code、Typora、语雀
- 图片存储:项目内部或图床
4.2 版本管理
- 与代码一同纳入 Git 管理
- 提交信息清晰,说明文档变更
- 定期备份,防止丢失
5. 审核与发布
5.1 审核流程
- 编写完成后进行自我检查
- 提交给相关人员审核
- 根据反馈修改完善
- 最终确认发布
5.2 发布规范
- 发布前检查格式和内容
- 明确文档版本号
- 通知相关人员文档更新
- 确保文档可访问
6. Markdown 文档模板
# 文档标题
## 1. 引言
### 1.1 文档目的
- 说明文档的编写目的
### 1.2 适用范围
- 说明文档的适用范围
### 1.3 术语定义
- 解释文档中使用的专业术语
## 2. 主体内容
### 2.1 功能描述
- 详细描述功能特性
### 2.2 实现方案
- 说明技术实现方案
### 2.3 代码示例
```php
// 代码示例
function example() {
return true;
}
2.4 操作步骤
- 第一步操作
- 第二步操作
- 第三步操作
3. 结论
3.1 总结
- 总结文档的主要内容
3.2 后续计划
- 说明后续的工作计划
4. 附录
4.1 参考资料
- 列出参考的文档和资源
4.2 联系方式
- 提供联系人信息
版本: 1.0 作者: 文档作者 更新日期: YYYY-MM-DD
## 7. Markdown 语法指南
### 7.1 标题
```markdown
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
7.2 列表
- 无序列表项 1
- 无序列表项 2
- 嵌套列表项
- 有序列表项 1
- 有序列表项 2
7.3 链接和图片
7.4 代码块
// JavaScript 代码
console.log('Hello World');
7.5 表格
| 表头 1 | 表头 2 |
|---|---|
| 单元格 1 | 单元格 2 |
| 单元格 3 | 单元格 4 |
7.6 引用
这是一段引用文本
8. 注意事项
- 避免冗长,重点突出
- 保持格式统一
- 定期更新文档
- 确保内容准确无误
- 便于他人理解和使用
- 生成文档最后说明由AI生成
以上规范适用于 CRMEB 项目所有文档写作,确保文档质量和一致性。

先判断是否适合
作者设计意图
作者的方法与取舍
边界和复核