编写用户手册
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_22182b4d/write-user-manual。
技能介绍
要解决什么问题
产品上线或新模块交付后,用户手册往往滞后于界面:路径靠口口相传、截图与字段名对不上、任务文档和参考页混在一起。更麻烦的是,文档作者在没有真实系统访问时只能凭材料「补全」流程,业务事实很容易被写成确定结论。
本技能面向 DevCube 等产品的新手册编写(不是旧文档治理或大规模重构),默认走「系统探索优先」:先弄清界面与状态,再按已确认模版落 .draft.md,检查通过且产品经理确认后再转正式页。
技能如何工作
工作流从任务分型开始:模块级(概述、快速开始、场景指南、任务与参考整包规划)或 单功能(判定页面类型与导航归属),以及评审/转正式。
在写任何 IA 规划或草稿前,会先卡 系统访问门禁:系统地址、登录或可用会话、功能路径与范围缺一不可;缺条件时只提醒补充(测试账号、会话协助等),不把凭据写进 Skill、手册或报告。用户明确「暂时无入口、先按材料写」时,才降级为截图/原型/字段清单驱动。
探索阶段按「菜单 → 列表/概览 → 目标数据 → 详情/表单 → 结果验证」深入,默认只读;写操作前说明目的与影响并请求确认。规划产出 manual-ia-plan-YYYYMMDD.md,导航固定为 模块概述、快速开始、常用任务、功能参考;常用任务下按能力分组,每组首篇为场景指南。
起草从 assets/templates/ 复制模版,写入目标目录的 *.draft.md,默认分批生成(一批一个功能组),每批更新截图矩阵、跑 scripts/check_manual_output.py,并写 manual-generation-report-YYYYMMDD.md。截图须页面加载完成;正式图放在文档就近 assets/,正文不引用探索临时目录。
适用边界
- 只写新内容:不要用它做历史手册治理或旧文档重构。
- 不编造事实:角色、权限、状态流转、风险等推断项进确认清单,由产品经理拍板后再回填。
- 转正式需明确确认:去
.draft后缀、同步内链、改mkdocs.yml前都要确认;已存在的正式文件不覆盖。
使用场景
- 新产品模块上线,需在测试环境按菜单路径探索界面并分批产出概述、快速开始与常用任务草稿
- 某个单功能页缺文档,要先判定页面类型并确定挂到「常用任务」下哪条能力分组
- 一批 `.draft.md` 已写完,要跑产出物检查、整理缺图清单并等产品经理确认业务事实后再转正式
- 暂时拿不到系统入口,但已有截图与字段清单,需按材料驱动方式先出 IA 规划与文字草稿
适合人员
- 负责 DevCube 类产品文档结构、按模版写 `.draft.md` 并维护截图矩阵的技术写作者
- 需在草稿转正式前确认角色、权限、状态流转与风险提示的产品经理
- 按发布模块做 `manual-ia-plan`、协作报告与 `check_manual_output.py` 检查的文档工程师
- 用测试账号准备样例数据、为多角色补场景指南与操作任务页的实施或培训文档同事