| File | Kind | Size |
|---|---|---|
| README.md | markdown | 2.3 KB |
| SKILL.md | skill md | 33.9 KB |
| examples/README.md | markdown | 555 B |
| examples/example_planning.md | markdown | 3.2 KB |
| examples/example_user_manual.md | markdown | 3.3 KB |
| templates/code_material.md | markdown | 800 B |
| templates/main_doc.md | markdown | 2.4 KB |
| templates/planning_doc_template.md | markdown | 3.2 KB |
| templates/user_manual.md | markdown | 14.3 KB |
templates/user_manual.md
View on GitHub<!--
⚠️ AI 生成警告 ⚠️
生成时必须将所有 {占位符} 替换为从项目代码中分析得到的实际内容。
如果无法确定某项内容,应使用 "待补充:[原因]" 格式标注。
禁止在最终文档中保留任何 {xxx} 格式的占位符!
-->
# {软件名称} 使用说明书
**文档名称**:{软件名称}用户手册
**版本号**:{版本号}
**编制日期**:{编制日期}
**体验环境**:{体验环境}
***
## 1. 系统功能说明
### 1.1 用户端功能
<!-- USER_EXAMPLE_START: 以下为示例内容,生成时必须全部替换为实际项目功能 -->
#### 1.1.1 用户注册与登录
**功能概述**
{根据源码分析:描述用户注册和登录流程}
**操作步骤**
1. 打开系统首页
**【需补充截图】** 系统首页界面
2. 点击"注册"按钮,填写注册信息
**【需补充截图】** 用户注册界面
- 用户名/手机号
- 密码设置
- 验证码验证
- {其他必填字段}
3. 提交注册信息,完成注册
**【需补充截图】** 注册成功提示
4. 使用账号密码登录系统
**【需补充截图】** 登录界面
**注意事项**
- {根据业务规则填充}
---
#### 1.1.2 {功能模块2}
{此处根据项目实际功能自动生成对应模块,例如:}
**示例功能模块(根据源码分析生成)**:
- 商品浏览
- 购物车管理
- 订单管理
- 个人中心(个人资料、密码修改、收货地址)
- 辅助功能(消息通知、帮助中心、意见反馈)
- 浏览记录/收藏夹
- 收货地址管理
- 优惠券管理
- 积分管理
- 等等...
**每个模块包含**:
- 功能概述(自动分析代码逻辑生成)
- 操作步骤(分析路由和组件生成)
- 截图占位标记
- 注意事项
#### 1.1.2 商品浏览(中等复杂功能示例)
**功能概述**
本功能为用户提供全面的商品浏览和查询体验。用户可以通过多种方式(分类导航、关键词搜索、筛选条件)快速定位目标商品。系统支持按价格、销量、评分等维度排序,帮助用户做出购买决策。商品详情页展示完整的商品信息、用户评价和购买建议,为用户提供充分的参考依据。此外,系统会记录用户的浏览历史,支持收藏和比较功能,提升用户购物效率。
**操作步骤**
1. **浏览商品列表**
用户登录系统后,首页默认展示推荐商品列表。用户可以通过以下方式查找商品:
- 点击顶部分类导航,选择感兴趣的商品类别
- 使用搜索框输入商品名称或关键词
- 使用筛选器设置价格区间、品牌、属性等条件
系统会实时更新商品列表,默认按综合排序展示结果。每个商品卡片显示商品主图、名称、价格、销量和评分信息。
**【需补充截图】** 商品列表界面(展示筛选、排序功能)
2. **查看商品详情**
用户在列表中点击感兴趣的商品,系统跳转至商品详情页。详情页从上到下依次展示:
- 商品轮播图(点击可放大查看)
- 商品名称、价格、促销信息
- 规格选择器(颜色、尺寸等)
- 购买数量输入框(默认为1,可增减)
- 商品详细描述(图文混排)
- 用户评价列表(支持筛选好评/差评)
用户可以通过"收藏"按钮将商品加入收藏夹,或点击"分享"按钮分享给好友。
**【需补充截图】** 商品详情页(标注关键功能区域)
3. **加入购物车或立即购买**
用户确认商品规格和数量后,可选择两种操作:
- **加入购物车**:系统提示"已添加至购物车",购物车角标数字增加,用户可继续浏览其他商品
- **立即购买**:系统直接跳转至订单确认页面,引导用户完成支付流程
如果选择的规格库存不足,系统会弹出提示:"当前规格库存不足,请选择其他规格或减少购买数量"。
**【需补充截图】** 加购成功提示 / 立即购买跳转
**使用场景**
- **场景一:目标明确的购买**
用户知道要买什么商品,直接使用搜索功能输入商品名称,快速定位并完成购买。
- **场景二:随意浏览**
用户没有明确购买目标,通过首页推荐和分类导航浏览感兴趣的商品,发现心仪商品后加入购物车。
- **场景三:比价决策**
用户对某类商品感兴趣,使用筛选功能对比不同品牌、价格的商品,查看详情和评价后做出购买决策。
**功能特点**
- **智能搜索**:支持模糊搜索、联想提示,快速定位目标商品
- **多维筛选**:提供价格、品牌、属性、评分等多个筛选维度,精准匹配用户需求
- **个性化推荐**:基于用户浏览历史和购买偏好,智能推荐相关商品
- **实时库存**:商品页面实时显示库存状态,避免下单后缺货
- **用户评价**:展示真实用户评价和晒图,帮助用户了解商品实际情况
---
#### 1.1.3 退出登录(简单功能示例)
**功能概述**
用户可以在个人中心退出当前账号,系统将清除登录状态并返回登录页面,保护账号安全。
**操作步骤**
1. **进入个人中心**
用户点击底部导航栏的"我的"图标,进入个人中心页面。
**【需补充截图】** 个人中心页面
2. **点击退出登录**
向下滑动至页面底部,点击"退出登录"按钮。系统弹出确认提示:"确定退出当前账号?",用户点击"确定"后,系统清除登录信息,自动跳转至登录页面。
**【需补充截图】** 退出确认弹窗
**功能特点**
- **安全退出**:退出后自动清除本地登录凭证
- **二次确认**:防止误操作导致意外退出
<!-- USER_EXAMPLE_END -->
---
### 1.2 管理端功能
<!-- ADMIN_EXAMPLE_START: 以下为示例内容,生成时必须全部替换为实际项目功能 -->
#### 1.2.1 管理员登录
**功能概述**
管理员通过后台登录页面进入管理系统。
**操作步骤**
1. 访问后台管理地址
**【需补充截图】** 后台登录页面
2. 输入管理员账号、密码和验证码
**【需补充截图】** 登录表单
3. 点击"登录"进入管理面板
**【需补充截图】** 管理后台首页
---
#### 1.2.2 {管理功能模块}
{根据后台源码自动分析并生成以下典型模块}
**可能的管理模块(根据源码实际分析)**:
##### A. 用户管理
**功能概述**
{分析后台用户管理模块代码:查看、编辑、删除用户信息,管理用户权限等}
**操作步骤**
1. 在后台菜单点击"用户管理"
**【需补充截图】** 用户列表界面
2. 查看用户列表,支持搜索和筛选
**【需补充截图】** 用户搜索功能
3. 点击"编辑"修改用户信息
**【需补充截图】** 用户编辑界面
4. 点击"删除"移除用户(需二次确认)
**【需补充截图】** 删除确认提示
**功能特点**
- {根据代码分析填充}
---
##### B. 商品管理(复杂功能示例)
**功能概述**
本功能为管理员提供全面的商品信息管理能力。管理员可以新增商品、编辑现有商品信息、调整商品上下架状态、管理商品库存和价格。系统支持批量导入商品数据,大幅提升商品录入效率。同时,系统提供商品分类管理、品牌管理、规格管理等辅助功能,帮助管理员构建完整的商品体系。所有商品操作都会记录日志,便于追溯和审计。
**操作步骤**
1. **进入商品管理**
管理员登录后台后,在左侧菜单栏点击"商品管理",系统展示商品列表页面。页面默认显示所有商品,支持按商品名称、分类、状态等条件筛选。
**【需补充截图】** 商品列表界面
2. **添加新商品**
点击页面右上角的"添加商品"按钮,系统打开商品编辑表单。管理员需要依次填写:
- 基本信息:商品名称、商品编号、所属分类、品牌
- 价格信息:市场价、销售价、成本价
- 库存信息:总库存、预警库存
- 商品图片:主图和详情图(支持拖拽上传,最多9张)
- 商品详情:使用富文本编辑器编辑商品描述
- 规格设置:如有多规格,点击"添加规格"设置SKU信息
填写过程中,系统会实时验证必填项和格式要求。如果商品编号已存在,系统会提示"商品编号重复,请重新输入"。
**【需补充截图】** 商品添加表单
3. **提交并发布**
信息填写完成后,管理员点击"保存并上架"按钮,系统执行以下操作:
- 验证所有必填项是否完整
- 检查图片是否已上传
- 保存商品信息至数据库
- 将商品状态设置为"上架"
- 返回商品列表页面,新商品显示在列表首位
系统弹出提示:"商品添加成功,已自动上架"。如果管理员选择"仅保存",商品会保存为草稿状态,不会在前台显示。
**【需补充截图】** 添加成功提示
**功能特点**
- **批量操作**:支持批量导入商品数据(Excel格式),支持批量修改价格、库存
- **多规格管理**:灵活的SKU管理,支持颜色、尺寸等多维度规格组合
- **图片管理**:支持本地上传和云存储,自动生成缩略图,节省存储空间
- **库存预警**:当商品库存低于预警值时,自动发送通知给管理员
- **操作日志**:记录商品的所有修改历史,包括操作人、操作时间、修改内容
---
##### C. 订单管理
**功能概述**
{分析订单管理模块:查看订单列表、订单详情、修改订单状态、处理退款等}
**操作步骤**
1. 查看订单列表
- 支持多条件筛选(订单状态、时间范围、用户信息等)
**【需补充截图】** 订单列表界面
2. 查看订单详情
- 订单基本信息
- 商品明细
- 物流信息
- 支付信息
**【需补充截图】** 订单详情页面
3. 订单操作
- 发货
- 退款处理
- 订单取消
**【需补充截图】** 订单操作界面
**功能特点**
- {根据代码分析填充}
---
##### D. {其他管理模块}
{根据实际项目源码分析生成,可能包括}:
- 分类管理
- 品牌管理
- 评论管理
- 营销管理(优惠券、活动、积分等)
- 分销管理
- 财务管理
- 数据统计
- 系统设置
- 权限管理
- 系统管理(角色权限、操作日志、部门管理)
- 等等...
**每个模块的标准结构**:
- 功能概述(基于代码分析)
- 操作步骤(提取关键流程)
- 截图占位
- 功能特点说明
---
##### E. 系统管理(后台隐形功能)
**功能概述**
{分析系统管理模块:角色权限管理、操作日志查看、系统参数配置、部门组织管理等}
**操作步骤**
1. 角色/权限管理
- 创建角色并分配菜单权限
- 管理管理员账号
**【需补充截图】** 角色权限分配界面
2. 系统日志
- 查看用户登录日志
- 查看关键操作记录
**【需补充截图】** 日志查询界面
3. 基础设置
- 维护数据字典
- 配置系统参数
**【需补充截图】** 系统设置界面
**功能特点**
- {根据代码分析填充:如RBAC模型、操作留痕等}
<!-- ADMIN_EXAMPLE_END -->
---
## 附录
### 附录 A:术语表
| 术语 | 说明 |
|------|------|
| {术语1} | {说明} |
| {术语2} | {说明} |
| {术语3} | {说明} |
### 附录 B:系统更新日志
| 版本号 | 更新日期 | 更新内容 |
|--------|----------|----------|
| {版本} | {日期} | {更新说明} |
---
**文档版本**:{版本号}
**最后更新**:{更新日期}
**编制单位**:{编制单位名称}
---
## 🔧 模板使用说明(此部分在生成时会被删除)
### 本模板的自动填充逻辑
1. **基本信息部分**:
- 标题、版本号、编制日期等从用户输入和项目配置中获取
2. **用户端功能**(第 1.1 节):
- 扫描前端路由文件(如 `router/index.js`, `pages/` 目录等)
- 分析 Vue/React 组件结构
- 提取页面名称、功能描述
- 生成操作步骤框架
3. **管理端功能**(第 1.2 节):
- 扫描后台管理路由和菜单配置
- 分析后台组件和 API 调用
- 识别 CRUD 操作模式
- 生成管理功能模块说明
4. **截图占位**:
- 在每个关键操作步骤处标记 **【需补充截图】**
- 用户手动添加实际截图
### 代码分析要点
- **路由文件**:提取页面路径和名称
- **组件文件**:分析功能逻辑和用户交互
- **API 调用**:了解数据操作类型(增删改查)
- **表单字段**:识别用户需要填写的信息
- **权限配置**:区分用户端和管理端功能
### ⚠️ 常见错误示例(生成时必须避免)
#### 错误示例 1:功能描述过于简单
❌ **不合格**:
```markdown
#### 订单管理
**功能概述**
管理员可以查看和处理订单。
**操作步骤**
1. 点击订单管理
2. 查看订单列表
3. 处理订单
```
✅ **合格**:功能概述至少 3 句话,操作步骤需包含系统响应。参考上方"商品管理(复杂功能示例)"。
#### 错误示例 2:操作步骤只有动作没有响应
❌ **不合格**:"点击提交按钮"
✅ **合格**:"点击'提交'按钮,系统验证信息后弹出'提交成功'提示"
#### 错误示例 3:使用技术术语
❌ **不合格**:"调用 API 获取数据"
✅ **合格**:"系统从服务器获取最新数据并刷新页面"
#### 错误示例 4:模糊表述
❌ **不合格**:"点击按钮"、"填写信息"
✅ **合格**:"点击'立即购买'按钮"、"依次填写商品名称、价格、库存"
### 📋 功能复杂度分类指南
生成时根据功能实际复杂度选择合适的详细程度:
| 功能类型 | 功能概述 | 操作步骤 | 使用场景 | 功能特点 | 示例 |
|----------|----------|----------|----------|----------|------|
| **复杂功能** | 100-150字 | 3步以上,每步详细 | 必须有2-3个 | 3-5个 | 订单管理、支付流程、审核流程 |
| **中等功能** | 60-100字 | 2-3步,适度详细 | 推荐1-2个 | 2-3个 | 商品浏览、购物车、个人资料 |
| **简单功能** | 30-50字 | 1-2步,简洁清晰 | 可省略 | 1-2个 | 退出登录、切换语言、清除缓存 |
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |