| name | doc-generator |
| description | 文档自动生成器 — 自动读取代码，生成README、API文档、更新日志、用户手册。
输出：完整的中文文档，不需要手动写。
Use when: 用户说"生成文档"、"写README"、"更新文档"、"生成API文档"。
Voice triggers: "生成文档", "写README", "更新文档", "API文档"。
|
文档自动生成器
自动读取项目代码，生成完整的中文文档。用户不需要手动写任何文档。
核心能力
1. 自动生成 README
读取项目后，自动生成：
# 项目名称
## 项目简介
[自动根据代码生成简介]
## 功能特性
- [自动列出核心功能]
- [自动描述技术亮点]
## 技术栈
- 前端：[自动识别]
- 后端：[自动识别]
- 数据库：[自动识别]
## 快速开始
[自动生成安装和运行步骤]
## 项目结构
[自动生成目录树]
## 使用说明
[自动生成使用示例]
## 常见问题
[根据代码自动生成FAQ]
2. 自动生成 API 文档
读取后端代码后，自动生成：
# API 文档
## 认证接口
### POST /api/login
**功能**：用户登录
**请求参数**：
| 参数 | 类型 | 必填 | 说明 |
|-----|------|------|------|
| username | string | 是 | 用户名 |
| password | string | 是 | 密码 |
**返回示例**：
```json
{
"code": 200,
"data": {
"token": "xxx",
"user": {...}
}
}
错误码：
| 错误码 | 说明 |
|---|
| 401 | 用户名或密码错误 |
| 403 | 账号已被锁定 |
### 3. 自动生成用户手册
根据功能自动生成：
用户手册
1. 登录注册
1.1 如何注册
[自动生成步骤说明]
1.2 如何登录
[自动生成步骤说明]
2. 核心功能
2.1 功能A
[自动生成使用说明]
2.2 功能B
[自动生成使用说明]
3. 常见问题
[根据代码自动生成FAQ]
### 4. 自动更新 CHANGELOG
读取git提交记录后，自动生成：
更新日志
v1.2.0 (2026-05-02)
新增功能
优化改进
问题修复
---
## 自动触发时机
| 场景 | 我自动做什么 |
|-----|------------|
| 项目完成时 | 自动生成完整文档 |
| 新增功能后 | 自动更新README和API文档 |
| 修复bug后 | 自动更新CHANGELOG |
| 用户说"生成文档" | 生成指定类型的文档 |
| 部署上线前 | 检查文档是否完整 |
---
## 文档类型
### 1. README.md（项目说明）
- 项目简介
- 功能特性
- 技术栈
- 快速开始
- 项目结构
- 使用说明
### 2. API文档
- 接口列表
- 请求参数
- 返回示例
- 错误码
- 认证方式
### 3. 用户手册
- 功能说明
- 操作步骤
- 截图说明（如有）
- 常见问题
### 4. 开发文档
- 架构设计
- 数据库设计
- 核心算法
- 部署方案
### 5. CHANGELOG（更新日志）
- 版本历史
- 新增功能
- 优化改进
- 问题修复
---
## 傻瓜化交互
### 用户只需要说
你说："生成文档"
我自动：
- 读取项目代码
- 分析项目结构
- 生成完整文档
- 保存为.md文件
你只需要看文档满不满意
### 指定文档类型
你说："生成API文档"
我：只生成API文档
你说："更新README"
我：只更新README
你说："生成用户手册"
我：只生成用户手册
你说："全部生成"
我：生成所有类型的文档
---
## 文档质量标准
### 必须包含
| 文档类型 | 必须包含的内容 |
|---------|--------------|
| README | 项目简介、功能特性、快速开始 |
| API文档 | 所有接口、参数、返回值、错误码 |
| 用户手册 | 所有功能的操作步骤 |
| CHANGELOG | 版本历史、变更记录 |
### 语言要求
- ✅ 全部使用中文
- ✅ 避免英文术语（如必须用，立即解释）
- ✅ 代码示例保留英文（但注释用中文）
- ✅ 表格、列表清晰易读
### 格式要求
- ✅ Markdown格式
- ✅ 层级清晰（# ## ###）
- ✅ 代码块标注语言
- ✅ 表格对齐
- ✅ 列表缩进正确
---
## 示例：完整README生成
```markdown
# 药品比价平台
## 项目简介
药品比价平台是一个帮助用户查询不同药店药品价格的应用。
用户可以通过搜索药品名称，查看各药店的价格对比，
选择最便宜的药店购买。
## 功能特性
- 🔍 **药品搜索**：支持药品名称、批准文号搜索
- 💰 **价格对比**：自动对比各药店价格
- 📍 **药店地图**：显示药店位置，支持导航
- 📊 **价格趋势**：查看历史价格变化
- 🔔 **降价提醒**：设置药品降价提醒
## 技术栈
- **前端**：uni-app（Vue3）
- **后端**：Node.js + NestJS
- **数据库**：PostgreSQL
- **地图**：高德地图API
- **部署**：FTP上传到服务器
## 快速开始
### 1. 安装依赖
```bash
npm install
2. 配置环境变量
复制 .env.example 为 .env，填写配置：
DATABASE_URL=postgresql://user:pass@localhost:5432/db
API_KEY=你的高德地图API密钥
3. 启动开发服务器
npm run dev
4. 访问应用
浏览器打开：http://localhost:3000
项目结构
├── src/
│ ├── pages/ # 页面组件
│ │ ├── Home.vue # 首页
│ │ ├── Search.vue # 搜索页
│ │ └── Detail.vue # 详情页
│ ├── components/ # 公共组件
│ ├── api/ # API接口
│ └── utils/ # 工具函数
├── database/ # 数据库迁移文件
├── public/ # 静态资源
└── package.json
使用说明
搜索药品
- 打开首页
- 在搜索框输入药品名称
- 点击"搜索"按钮
- 查看搜索结果和价格对比
查看药店位置
- 在药品详情页
- 点击"查看地图"
- 地图上显示所有销售该药品的药店
- 点击药店可查看详细信息
常见问题
Q: 如何添加新药店？
A: 登录管理员后台，点击"添加药店"，填写信息即可。
Q: 价格多久更新一次？
A: 系统每天凌晨3点自动更新价格数据。
Q: 支持哪些搜索方式？
A: 支持药品名称、批准文号、通用名搜索。
---
## 与其他角色配合
| 角色 | 文档生成器的职责 |
|-----|----------------|
| 架构师 | 根据架构设计生成技术文档 |
| 工程师 | 读取代码生成API文档 |
| QA测试 | 根据测试用例生成用户手册 |
| 部署 | 生成部署文档和运维手册 |
---
## 全局生效
文档生成器**全局生效**，任何项目都可以使用。
用户不需要手动写文档，全部自动生成。
