业务操作手册生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_492eb511/operation-manual-generator。
技能介绍
要解决什么问题
仓库里往往只有代码和给开发者的接口文档,一线运营、客服、仓管要上手系统时,要么追着研发问「这个按钮点了会怎样」,要么自己试错。和面向产品的 code-to-doc-generator 不同,本技能产出的是给不懂代码的人看的操作手册:按业务场景分节,说明点哪里、填什么、提交后状态怎么变,而不是 PRD/HLD 或带〔INFER〕标注的分析文档。
技能如何工作
工作流分四步,并强调先确认端与受众(C 端 H5、B 端后台、小程序等不要默认全写)。
- 盘点操作清单:先读 README/API/docs,再结合前端路由/菜单与后端 Controller 分组,按业务流程排出手册目录,与用户确认后再写。
- 逐操作对齐前后端:从前端提取入口、权限、表格列、按钮与真实文案;从后端提取接口逻辑、状态流转、副作用与校验规则,用来写「提交后系统会怎样」。
- 写手册并配图:每节标配文字步骤、依据组件代码还原的 SVG 线框图(
images/*.svg)、Mermaid 流程/状态/时序图,以及字段与状态对照表;正文全程去技术化,推断内容收进附录。 - 保存与自检:输出到
docs/[项目名]/[端名]操作手册.md,按受众语言、图文配套、界面保真等项自检后汇报。
适用边界与注意点
- 示意图是代码推导的线框图,不是浏览器真截图;需要 PNG 时可选用附带脚本批量转换,默认 SVG 即可在常见 Markdown 查看器中显示。
- 只读代码无法还原的业务背景应记入「待业务确认」,不要硬编。
- 若读者是实施或接手开发,可与用户约定放宽正文去技术化程度;默认读者为一线业务人员。
使用场景
- B 端后台改版或新功能上线后,需要按侧边栏菜单整理「点哪、填什么、提交后订单/单据状态如何变」的图文手册给运营跟做。
- 客服或实施要向非技术人员讲解 C 端 H5/小程序流程,需从前端路由与页面文案还原操作步骤,并配上流程图说明各步结果。
- 仓库里只有 README 与 API.md,一线人员看不懂接口路径,需要从 Controller 与前端表单字段生成去技术化的状态与字段对照表。
- 多端项目(如 uni-app + Java 后台)交付时,只需为某一端(如仓管后台)写手册,要先识别端类型再按业务流程排章,避免按代码目录堆砌。
适合人员
- 负责新业务培训的运营负责人,要在不依赖研发逐页截图的前提下,从代码仓产出可下发的后台操作 SOP。
- 每天处理订单、退换货咨询的客服主管,需要与系统一致的按钮名、入口路径及「点击发货/审核后状态名」说明。
- 从客户代码做上线交付的实施顾问,要把权限、审核、下推等 B 端操作写成客户仓管或文员能照做的分步手册。
- 接手遗留业务系统的培训同事,希望手册按「注册—下单—履约—售后」等业务顺序组织,而不是按 Controller 名称排列章节。