← ClaudeAtlas

pm-operation-manuallisted

用于生成、撰写或创建操作手册或用户指南的技能。 触发场景:(1) "生成操作手册" "写操作手册" "创建操作手册" "用户手册", (2) "使用说明" "功能说明文档" "快速入门" "用户指南", (3) "导出操作手册" "操作手册导出Word" "用户手册转Word", (4) 生成系统管理员操作手册, (5) 生成终端用户手册或快速入门指南。 基于需求文档和现有前端页面生成操作手册。
iDWong/pm-skills · ★ 1 · AI & Automation · score 74
Install: claude install-skill iDWong/pm-skills
> **流程位置**:`pm-master` 13 阶段流程的**阶段8 操作手册**,也可单点直接调用。 > 流程内落盘路径 `docs/{日期}-{项目}-用户操作手册-V{版本}.md`(流程门禁按 glob 匹配,命名带产品名/日期是正常的)。 > 上游读 `SPEC_SOURCE` + 阶段6 的 `src/`(若有)。 # 操作手册生成器 ## 角色定义 以资深技术文档工程师视角工作: - ✅ 操作步骤完整清晰,不省略任何关键步骤 - ✅ 使用第二人称("您"),界面元素用【】标注 - ✅ 每个功能覆盖:概述、新增、查询、编辑、删除及特殊操作 - ✅ 重要提示用"注意:"或"⚠️"标注 - ❌ 不用技术术语("调用接口"、"API请求") - ❌ 不说"系统会自动",说"系统将显示/提示/跳转到" ## 支持的手册类型 | 类型 | 受众 | 特点 | |------|------|------| | 用户操作手册 | 终端用户 | 图文步骤,通俗语言,场景导向 | | 管理员手册 | 系统管理员 | 完整功能,配置说明,权限管理 | | 快速入门指南 | 新用户 | 只覆盖核心功能,10分钟上手 | ## 执行流程 ### Step 0: 扫描项目上下文 先主动扫描项目,找到已有文档再开始工作: | 优先级 | 文件类型 | 查找方式 | |--------|---------|---------| | 最高 | 需求说明书 | `Glob("**/*需求*说明书*.md")` | | 高 | 功能清单 | `Glob("**/*功能*清单*.md")` | | 低 | 路由/代码 | `src/router/`, `src/views/`, `src/api/` | 扫描完成后直接基于内容工作,只询问一件事:**是否需要自动截图**(需要先启动开发服务器)。 ### Step 1: 读取模板 读取 `references/templates/operation-manual.md`,按模板结构生成文档。 ### Step 2: 生成任务清单 **必须先展示任务清单,再逐个生成,禁止一次性写入整个文档。** 任务拆分原则:**拆到最小粒度,每个功能模块的每个子操作(新增、查询、编辑、删除、特殊操作)都是独立任务。** 任务清单示例: ``` | 序号 | 任务名称 | 状态 | |------|---------|------| | 1 | 创建文档骨架 | ⏳ 等待中 | | 2 | 一、文档信息 + 二、系统简介 | ⏳ 等待中 | | 3 | 三、快速开始 | ⏳ 等待中 | | 4 | 4.1 工作台 - 功能概述 | ⏳ 等待中 | | 5 | 4.1 工作台 - 待办事项操作 | ⏳ 等待中 | | 6 | 4.2.1 设备档案 - 功能概述 | ⏳ 等待中 | | 7 | 4.2.1 设备档案 - 新增设备 | ⏳ 等待中 | | 8 | 4.2.1 设备档案 - 查询筛选 | ⏳ 等待中 | | 9 | 4.2.1 设备档案 - 编辑设备 | ⏳ 等待中 | | 10 | 4.2.1 设备档案 - 删除设备 | ⏳ 等待中 | | 11 | 4.2.1 设备档案 - 导出数据 | ⏳ 等待中 | | 12 | 4.2.2 设备分类 - 功能概述 | ⏳ 等待中 | ... | N | 五、常见问题 + 六、联系支持 | ⏳ 等待中 | ``` 执行规则: 1. 每