不二云微操作文档完善设计 #
目标 #
盘点不二云微现有文档与实际产品功能,形成一份完整的操作教程目录,并按优先级逐篇完善。教程需要让首次使用系统的用户能够根据文档独立完成配置或操作,而不是只了解功能名称。
覆盖范围 #
- 主系统、外卖、店内、区域代理、SCRM、鲫鱼、IM 等后台模块。
- 用户端、商户端、配送端等实际使用流程。
- 微信、支付宝、抖音、随行付、存储、短信、地图、配送、打印等第三方平台配置。
- 现有
docs/guide操作指南及与操作流程相关的docs/module内容。
开放接口文档继续保留在 docs/open,只在某项操作教程确实需要调用开放能力时提供入口链接,不在操作教程中重复接口字段说明。
目录组织 #
采用“业务模块分组 + 任务型教程”的混合结构:
- 一级分组帮助用户判断业务范围,例如基础配置、外卖运营、商户与连锁、配送、营销、支付结算、增值应用、第三方平台。
- 每篇教程只解决一个明确任务,例如“如何设置准时宝”“如何创建连锁店”“如何使用 IM”“如何配置电影票”。
- 一项任务跨越多个后台或第三方平台时,仍保留为一篇完整教程,并在步骤中明确切换平台。
- 功能介绍页与操作教程分开;介绍页说明能力,教程页说明如何完成操作,并互相提供自然链接。
完整目录清单字段 #
每个待盘点项目记录以下信息:
| 字段 | 说明 |
|---|---|
| 教程名称 | 使用“如何……”或明确动作命名 |
| 业务分组 | 所属一级目录 |
| 使用角色 | 平台、代理、商户、骑手、用户等 |
| 实际入口 | 当前版本的后台或第三方平台菜单路径 |
| 现有文档 | 对应文件及可复用内容 |
| 处理方式 | 保留、完善、拆分、新建或合并 |
| 截图需求 | 需要补拍的关键页面和操作状态 |
| 外部依赖 | 账号、资质、第三方服务或前置配置 |
| 优先级 | 高频核心流程优先,其次是增值和低频流程 |
| 状态 | 待核对、待编写、待截图、待验证、已完成 |
单篇教程模板 #
每篇教程统一包含:
- 适用场景:说明教程解决什么问题。
- 前置条件:列出模块、账号、资质和外部服务要求。
- 操作入口:写清角色、平台和菜单路径。
- 分步操作:按用户实际点击顺序编写,一步只表达一个动作。
- 效果验证:说明如何确认配置已经生效。
- 常见问题:只收录真实流程中容易出错或已有反馈的问题。
页面核对与截图 #
- 以实际网页当前可见的菜单、字段和状态为准,不根据旧截图猜测。
- 先完整走通只读路径,再确定最少且足够的截图节点。
- 截图仅保留完成操作所需区域;出现手机号、订单号、密钥、余额等信息时先遮挡或改用无敏感数据的测试页面。
- 图片使用能表达操作内容的中文替代文本和稳定文件名,上传到现有
booldoc.oss-cn-chengdu.aliyuncs.com/images/图床后再写入文档。 - 上传图片属于外部写入;每批上传前确认目标账号、目录和文件清单,上传后逐个验证链接可访问。
盘点与编写顺序 #
- 提取实际系统各模块的菜单与页面入口。
- 建立现有文档索引,并将文档映射到实际功能。
- 形成完整目录,标记缺失、重复、过时和截图问题。
- 先完成高频核心教程样板,再按相同标准逐批扩展。
- 每篇教程完成后核对页面入口、操作顺序、截图、链接和侧边栏入口。
首批样板建议为:准时宝设置、连锁店设置、IM 使用和电影票配置。它们分别覆盖第三方服务、跨商户业务、增值模块和内容配置,可用于验证模板是否适合不同类型的教程。
验证边界 #
- 文档目录盘点以当前本地测试环境已安装模块和当前仓库内容为准。
- 只读查看能够确认菜单、字段和流程入口,但不能证明涉及支付、消息、配送、出票等外部业务最终成功。
- 涉及外部业务结果时,教程需要明确区分“配置已保存”“接口连接正常”和“真实业务已完成”。
- 文档改动至少运行
git diff --check;修改侧边栏后额外运行node -c。