Files
users/开发文档/模板使用说明书.md

313 lines
10 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🎯 全能开发模板 - 智能开发中台 v2.0
> **核心理念**: 这不是一堆文档,而是一套 **"AI 驱动的虚拟团队"**
> **使用心法**: **"拖入即激活"** - 把文件拖入 AI 对话框AI 瞬间变身该领域专家
> **最新技术**: 融合 DocAgent 多智能体协作 + RAG 文档检索 + 自动化工作流
> **内置 Skill**: 项目管理专家 Skill自动管理进度、任务、对话上下文
---
## 🆕 内置项目管理 Skill
本模板内置了 **项目管理专家 Skill** (`.cursor/skills/dev-template-project-manager/`)
```
📁 .cursor/skills/dev-template-project-manager/
├── 📄 SKILL.md ← 主技能文件AI 自动读取)
├── 📄 workflow.md ← 工作流详解
├── 📄 templates.md ← 文档模板库
├── 📄 commands.md ← 完整指令参考
└── 📄 integration.md ← 与开发模板集成指南
```
**核心功能**
- 📊 项目进度管理(执行表、甘特图)
- 📋 需求自动拆解为任务
- 💾 对话上下文跨会话存储
- 📝 提示词库管理
- 🔗 文档联动自动更新
**快速激活**每次使用开发模板时AI 会自动读取此 Skill 并激活项目管理能力。
---
## 🚀 一、极速启动 (30秒上手)
### 方式一:一键全量展开
1. 打开 `AI开发引擎.md`
2. 拖入 AI 对话框
3. 输入你的项目需求
4. AI 自动生成 1-10 全套文档
```
@AI引擎 请展开项目:
【项目名称】:私域银行 v2.0
【核心功能】:流量池管理、分润计算、一键提现
【预期规模】:日活 1 万
```
### 方式二:单目录精准展开
1. 进入对应目录(如 `4、前端`
2. 打开 `_智能展开.md`
3. 拖入 AI 对话框
4. AI 变身该领域专家
---
## 🗂️ 二、目录全景图
```
📁 开发模板/
├── 📄 AI开发引擎.md ← 🧠 总控:一键展开全部
├── 📄 代码核心提取器.md ← 🔬 分析项目、提取核心、清理文件
├── 📄 模板使用说明书.md ← 📖 你正在看的这个
├── 📁 1、需求/ ← 💰 CFO + 产品负责人
│ ├── _智能展开.md ← 🔮 智能展开提示词
│ ├── 业务需求.md
│ ├── 技术需求.md
│ └── 成本.md
├── 📁 2、架构/ ← 🏗️ CTO + 架构师
│ ├── _智能展开.md
│ ├── 系统架构.md
│ └── 技术选型.md
├── 📁 3、原型/ ← 🎨 UI/UX 设计师
│ ├── _智能展开.md
│ └── 原型设计规范.md
├── 📁 4、前端/ ← ⚛️ 前端技术专家
│ ├── _智能展开.md
│ └── 前端开发规范.md
├── 📁 5、接口/ ← 🔌 API 架构师
│ ├── _智能展开.md
│ └── 接口定义规范.md
├── 📁 6、后端/ ← 🐍 Python 架构师
│ ├── _智能展开.md
│ └── 后端开发规范.md
├── 📁 7、数据库/ ← 💾 DBA
│ ├── _智能展开.md
│ └── 数据库管理规范.md
├── 📁 8、部署/ ← 🚀 DevOps 运维
│ ├── _智能展开.md
│ └── 项目程序提示词.md
├── 📁 9、手册/ ← 📚 技术文档专家
│ ├── _智能展开.md
│ └── 使用手册提示词.md
└── 📁 10、项目管理/ ← 📊 高级 PM
├── _智能展开.md
└── 项目管理提示词.md
```
---
## 🎮 三、核心操作指南
### 3.1 按场景选择入口
| 我要做什么 | 使用哪个文件 | AI 会帮我 |
|:---|:---|:---|
| **新项目启动** | `AI开发引擎.md` | 一键生成全套文档 |
| **分析现有项目** | `代码核心提取器.md` | 提取核心代码、清理无关文件 |
| **算账/定功能** | `1、需求/_智能展开.md` | 成本估算、MVP 边界 |
| **技术选型** | `2、架构/_智能展开.md` | 架构图、技术栈对比 |
| **画页面** | `3、原型/_智能展开.md` | 页面结构、iOS 规范 |
| **写前端代码** | `4、前端/_智能展开.md` | React 组件、Tailwind |
| **定义接口** | `5、接口/_智能展开.md` | API 文档、错误码 |
| **写后端代码** | `6、后端/_智能展开.md` | FastAPI、AI 集成 |
| **设计数据库** | `7、数据库/_智能展开.md` | ER 图、向量索引 |
| **部署上线** | `8、部署/_智能展开.md` | 脚本、CI/CD |
| **写用户手册** | `9、手册/_智能展开.md` | 傻瓜式文档、营销文案 |
| **管理项目** | `10、项目管理/_智能展开.md` | 甘特图、执行表 |
### 3.2 联动组合拳
不要只用一个文件,学会**组合**使用:
**场景:我要做一个 AI 客服功能**
```
第一步(定钱): 拖入 1、需求/_智能展开.md
→ 问:"加这个功能要多少 API 成本?"
第二步(定架构): 拖入 2、架构/_智能展开.md
→ 问:"用 LangChain 还是原生 API"
第三步(定接口): 拖入 5、接口/_智能展开.md
→ 指令:"@生成接口 AI 对话模块"
第四步(落地): 拖入 10、项目管理/_智能展开.md
→ 指令:"把这个功能拆解成任务"
```
---
## 🔮 四、智能展开指令速查表
### 4.1 全局指令
| 指令 | 功能 | 在哪用 |
|:---|:---|:---|
| `@全量展开 [项目]` | 一键生成 1-10 全套文档 | AI开发引擎 |
| `@展开[N] [内容]` | 展开指定目录 | AI开发引擎 |
| `@联动更新` | 基于变更同步所有文档 | AI开发引擎 |
| `@全量分析 [路径]` | 分析项目、提取核心代码 | 代码核心提取器 |
| `@清理建议` | 生成可删除文件列表 | 代码核心提取器 |
| `@快速理解 [路径]` | 快速理解项目架构 | 代码核心提取器 |
### 4.2 各目录专属指令
| 目录 | 常用指令 |
|:---|:---|
| 1、需求 | `@拆解需求` `@用户故事` `@成本估算` `@MVP边界` |
| 2、架构 | `@技术选型` `@架构图` `@模块拆分` `@安全检查` |
| 3、原型 | `@页面结构` `@页面流程` `@iOS样式` `@骨架屏` |
| 4、前端 | `@生成页面` `@生成组件` `@生成Hook` `@样式优化` |
| 5、接口 | `@生成接口` `@接口详情` `@时序图` `@Mock数据` |
| 6、后端 | `@生成路由` `@生成服务` `@生成AI服务` `@安全检查` |
| 7、数据库 | `@生成集合` `@生成ER图` `@生成索引` `@向量配置` |
| 8、部署 | `@生成部署脚本` `@生成Nginx` `@生成Docker` |
| 9、手册 | `@生成手册` `@生成FAQ` `@生成文案` `@话术优化` |
| 10、管理 | `@拆解任务` `@更新进度` `@甘特图` `@生成复盘` |
---
## 🏛️ 五、核心规则(必读)
### 5.1 卡若风格规则
```yaml
输出风格:
语言: 大白话,直击要点
结构: 结论→原因→步骤
可视化: 必须包含 Mermaid 图表
代码: 必须中文注释
技术规范:
前端: React + Shadcn UI + Tailwind CSS + iOS 风格
后端: Python FastAPI + Type Hints + 异步优先
数据库: MongoDB 优先(含向量索引)
部署: Webhook 自动化 + 宝塔/Docker
安全红线:
禁止: 硬编码密钥、os.system()、rm -rf
强制: 参数化查询、Type Hints、骨架屏
```
### 5.2 云阿米巴商业规则
```yaml
分钱原则: 分不属于对方的钱
价值绑定: 按创造价值分钱
流量锁定: 用稳定流量 + 便捷私域体系绑定合作方
产品规则:
- 页面必须有流量入口
- 分润数据必须醒目显示
- 提现操作必须简单一键
```
---
## 🔄 六、文档自生长机制
### 6.1 更新规则
```
触发条件 → 自动更新动作
─────────────────────────
需求变更 → 更新架构、接口、前后端、执行表
接口变更 → 更新前端调用、后端实现、API 文档
数据库变更 → 更新 ER 图、后端 Model
代码完成 → 更新执行表状态为 ✅
```
### 6.2 同步指令
```
# 确定了数据库结构后
@联动 数据库→后端:基于 ER 图生成 Pydantic 模型
# 完成了后端开发后
@联动 后端→执行表:更新后端任务状态为完成
# 需求变更后
@联动 需求→全量:基于新需求更新所有相关文档
```
---
## 📊 七、权限与责任
| 目录 | 维护责任人 | 谁不能乱动 |
|:---|:---|:---|
| 1、需求 / 10、管理 | **卡若 (老板/PM)** | 开发人员(只读) |
| 2、架构 / 5、接口 | **架构师** | 非技术人员 |
| 4、前端 / 6、后端 | **对应开发** | 非本岗位人员 |
| 8、部署 | **运维/核心开发** | **所有人**(涉及密钥) |
---
## 🧠 八、最新 AI 技术融合
### 8.1 多智能体协作 (DocAgent)
本模板采用多智能体协作架构:
```
📖 Reader (需求理解) → 🔍 Searcher (上下文检索)
→ ✍️ Writer (内容生成) → ✅ Verifier (质量校验)
```
### 8.2 RAG 文档增强
- 支持 Gemini File Search 全托管 RAG
- MongoDB Atlas Vector Search 向量检索
- 自动从代码/文档/历史中提取上下文
### 8.3 自动化工作流
- GitHub Webhook 自动触发部署
- 文档变更自动同步
- 代码生成自动包含测试
---
## 💡 九、使用技巧
### 9.1 高效使用建议
1. **先读后写**: 开始新模块前,先读相关目录的现有文档
2. **指令明确**: 使用 `@指令` 格式AI 响应更精准
3. **上下文传递**: 在复杂任务中,把前一步的输出作为下一步的输入
4. **及时更新**: 每次变更后要求 AI 同步更新相关文档
### 9.2 常见问题
| 问题 | 解决方案 |
|:---|:---|
| AI 输出不符合规范 | 明确提醒"请按照卡若风格" |
| 文档不同步 | 使用 `@联动更新` 指令 |
| 代码风格不统一 | 检查是否使用了 `_智能展开.md` |
| 缺少图表 | 明确要求"请用 Mermaid 画图" |
---
## 📞 十、联系与支持
- **问题反馈**: 微信 28533368
- **模板更新**: 关注 GitHub 仓库
- **使用交流**: 扫码加入用户群
---
> **总结**: 这套模板是你的 **"数字化外脑"**,把卡若的经验固化成 Prompt让 AI 能随时按你的标准干活。用好它,你就是一支队伍。🚀