wang-q-l 操作手册生成
支持的手册类型
| 类型 | 受众 | 特点 |
|---|---|---|
| 用户操作手册 | 终端用户 | 图文步骤，通俗语言，场景导向 |
| 管理员手册 | 系统管理员 | 完整功能，配置说明，权限管理 |
| 快速入门指南 | 新用户 | 10分钟上手，只覆盖核心功能 |
| 功能说明文档 | 所有用户 | 功能索引，参考查阅型 |
工作流程
Step 1: 读取上下文
优先读取（如存在）：
docs/spec.md—— 需求说明书（获取功能模块结构）docs/requirements.md—— 需求文档- 项目中已生成的前端代码（了解实际界面结构）
用 AskUserQuestion 确认：
- 手册类型（用户手册 / 管理员手册 / 快速入门 / 功能说明）？
- 主要受众（技术水平、使用场景）？
- 是否需要截图占位说明？
Step 2: 分析功能结构
从需求说明书提取：
- 系统功能架构（菜单层级）
- 各功能模块的操作流程
- 用户角色和对应权限
- 关键业务规则和注意事项
Step 3: 生成手册
模板 A：用户操作手册（完整版）
# [系统名称] 用户操作手册
**版本**：v1.0 **更新日期**：[日期] **适用版本**：[系统版本号]
---
## 文档说明
本手册适用于 [目标用户描述]，帮助用户快速掌握 [系统名称] 的核心功能。
**阅读建议**：
- 新用户请从第2章"快速开始"开始阅读
- 如需查询特定功能，请使用目录快速定位
---
## 目录
1. [系统简介](#系统简介)
2. [快速开始](#快速开始)
3. [功能详解](#功能详解)
- 3.1 [功能模块A]
- 3.2 [功能模块B]
4. [常见问题](#常见问题)
5. [联系支持](#联系支持)
---
## 1. 系统简介
### 1.1 系统概述
[2-3句话描述系统是什么、解决什么问题]
### 1.2 主要功能
| 功能模块 | 功能说明 |
| -------- | ---------- |
| [模块A] | [简要说明] |
| [模块B] | [简要说明] |
### 1.3 系统访问
- **访问地址**：[URL 或 下载地址]
- **支持浏览器**：Chrome、Firefox、Safari、Edge（最新版）
- **推荐分辨率**：1920×1080 及以上
---
## 2. 快速开始
### 2.1 登录系统
1. 打开浏览器，访问 [系统地址]
2. 输入账号（用户名/手机号/邮箱）
3. 输入密码
4. 点击【登录】按钮
> **截图**：[登录页面截图] **提示**：首次登录请使用初始密码，登录后请立即修改密码
### 2.2 界面导航
系统界面由以下几个区域组成：
┌─────────────────────────────────────┐ │ 顶部导航栏（用户信息、通知、退出） │ ├──────────┬──────────────────────────┤ │ │ │ │ 左侧菜单 │ 主要内容区域 │ │ (功能导航) │ │ │ │ │ └──────────┴──────────────────────────┘
- **左侧菜单**：点击展开/收起各功能模块
- **内容区域**：显示当前功能的操作界面
- **顶部导航**：个人设置、消息通知、退出登录
### 2.3 10分钟快速上手
完成以下操作，即可掌握系统核心功能：
- [ ] 步骤1：[核心操作1]（约2分钟）
- [ ] 步骤2：[核心操作2]（约3分钟）
- [ ] 步骤3：[核心操作3]（约5分钟）
---
## 3. 功能详解
### 3.1 [功能模块A名称]
#### 3.1.1 功能概述
[1-2句话说明这个模块的作用]
**适用角色**：[管理员 / 普通用户 / 所有用户]
#### 3.1.2 [核心操作1：新增]
**操作步骤：**
1. 在左侧菜单中点击 **[模块名]**
2. 点击页面右上角的 **【+ 新增】** 按钮
3. 在弹出的表单中填写以下信息：
- **[字段1]**（必填）：[填写说明]
- **[字段2]**（必填）：[填写说明]
- **[字段3]**（选填）：[填写说明]
4. 确认信息无误后，点击 **【保存】**
5. 系统提示"保存成功"，数据出现在列表中
> **截图**：[新增弹窗截图]
> **注意**：
> - [字段1] 不能超过50个字符
> - [字段2] 在系统中必须唯一
#### 3.1.3 [核心操作2：查询]
**操作步骤：**
1. 进入 **[模块名]** 页面
2. 在搜索栏输入关键词，或选择筛选条件
3. 点击 **【查询】** 按钮，列表显示符合条件的数据
4. 点击 **【重置】** 可清空所有筛选条件
**支持的筛选条件：**
| 筛选项 | 说明 |
|--------|------|
| [字段A] | 支持模糊搜索 |
| [状态] | 下拉选择，默认"全部" |
| [时间范围] | 选择开始/结束日期 |
#### 3.1.4 [核心操作3：编辑]
1. 在列表中找到要修改的数据
2. 点击操作列的 **【编辑】** 按钮
3. 在弹窗中修改相应字段
4. 点击 **【保存】** 完成修改
> **注意**：灰色不可编辑的字段为系统自动生成，无法手动修改
#### 3.1.5 [核心操作4：删除]
1. 选中要删除的数据（单条点击操作列【删除】，多条勾选后点击【批量删除】）
2. 系统弹出确认对话框："确定要删除该数据吗？"
3. 点击 **【确定】** 完成删除
> **⚠️ 重要提示**：删除操作不可撤销，请谨慎操作！
> 已被其他功能引用的数据无法删除，需先解除关联。
### 3.2 [功能模块B名称]
[同上格式，根据实际功能模块依次展开]
---
## 4. 常见问题
### Q：忘记密码怎么办？
点击登录页的【忘记密码】，输入注册手机号/邮箱，按提示重置密码。
### Q：为什么某些功能按钮显示为灰色或不可见？
可能原因：您的账号没有该功能的操作权限。请联系系统管理员开通权限。
### Q：数据保存后在列表中看不到？
1. 检查当前的筛选条件，可能过滤掉了新数据
2. 点击【重置】清空筛选条件后重新查询
3. 如仍未出现，请联系技术支持
### Q：导出的文件无法打开？
建议使用 Microsoft Excel 或 WPS Office 打开 .xlsx 格式文件。
---
## 5. 联系支持
| 支持方式 | 联系信息 |
|---------|---------|
| 技术支持邮箱 | [邮箱地址] |
| 客服热线 | [电话] |
| 在线工单 | [工单系统地址] |
| 服务时间 | 工作日 9:00-18:00 |
模板 B：快速入门指南（精简版）
# [系统名称] 快速入门指南
> 预计阅读时间：10分钟完成后您将能够独立完成 [核心任务描述]
---
## 第一步：登录
访问 [地址]，输入账号密码登录。
> [登录页截图占位]
---
## 第二步：了解界面
[简单界面示意图，标注3-5个关键区域]
---
## 第三步：完成第一个核心任务
**场景**：[典型使用场景描述]
1. 点击左侧菜单 **[模块]**
2. 点击 **[核心操作按钮]**
3. 填写 [关键字段]
4. 点击 **【保存】**
完成！
---
## 下一步
入门完成后，建议进一步了解：
- [进阶功能A] → 查看完整手册第3.2章
- [进阶功能B] → 查看完整手册第3.3章
Step 4: 截图说明规范
手册中需要截图的位置，统一使用占位标注：
> **[截图]**：[描述截图内容，如"登录页面，标注账号输入框和登录按钮"]
> **建议标注**：[说明需要用箭头或圆圈标注的重点区域]
输出规范
- 用户操作手册：
docs/operation-manual-user.md - 管理员手册：
docs/operation-manual-admin.md - 快速入门：
docs/quick-start.md
写作原则
语言风格：
- 用第二人称（"您"），口吻友好
- 操作步骤用数字列表，每步一个动作
- 界面元素用【】标注（如【保存】按钮）
- 重要提示用"注意："或"⚠️"标注
避免：
- 不用"点击按钮"，用"点击【按钮名称】"
- 不说"系统会自动"，说"系统将显示/提示/跳转到"
Word 导出功能
操作手册文档可以导出为 Word 格式，使用公共文档导出工具。
文档要求
操作手册 Markdown 文件必须包含 YAML frontmatter：
---
title: '操作手册'
subtitle: "[项目名称]\n\n[客户名称]"
author: '编制单位：[编制单位名称]'
date: '[年月]'
lang: zh-CN
toc: true
---
导出命令
# 导出用户操作手册
bash .claude/skills/common/doc-export/scripts/export-word.sh docs/operation-manual-user.md
# 导出管理员手册
bash .claude/skills/common/doc-export/scripts/export-word.sh docs/operation-manual-admin.md
# 导出快速入门指南
bash .claude/skills/common/doc-export/scripts/export-word.sh docs/quick-start.md
样式说明
导出的 Word 文档使用统一的样式配置，与需求说明书、测试用例保持一致。详细配置请参考：.claude/skills/common/doc-export/README.md
- 不省略步骤，即使看起来"显而易见"