BMS 系统操作手册编写规范

1. 编写目标与适用对象

本文档用于统一 BMS 操作手册的目录、内容、截图、视频和核验标准。读者包括运营、财务、仓库、工厂一线人员及客户客服人员，因此内容应围绕“在什么场景下，如何操作，成功后看到什么，异常时怎么办”展开。涉及客服的功能，还应说明客户咨询时需要查看哪些信息、如何判断处理进度，以及何时转交仓库或运营人员。

不写部署说明、接口说明、代码实现、数据库结构和后端技术细节。只有技术人员才需要了解的内容，应放在其他技术文档中。

目录树保持与前端菜单一致，按以下层级组织：

docs/
├── 00-系统总览与登录.md
├── 01-功能目录.md
├── 管理端/
├── 服务端/
│   ├── 基础数据/
│   ├── 入库/
│   ├── 库存/
│   ├── 出库/
│   └── 售后工作台/
├── 客户端/
└── 99-待验证清单.md

# 功能名称
## 1. 功能说明
## 2. 使用前提
## 3. 页面入口
## 4. 操作步骤
## 5. 结果确认
## 6. 异常处理与限制
## 7. 常见问题

根据功能复杂度增删章节，但至少要说明功能用途、入口、操作步骤、成功标准和限制条件。字段说明使用表格；连续操作使用编号步骤；容易误操作的内容使用“注意”或“提示”。界面按钮、菜单、状态和提示语必须使用系统实际显示的文字，例如 确认收货、标记装满、创建上架单。

截图只保留能帮助用户完成操作的页面、弹窗和结果状态，不放无关代码或开发工具画面。截图按以下路径保存：

docs/assets/<端>/<一级菜单>/<功能模块>/

文件名使用两位数字加简短中文说明，按操作顺序编号，例如：

01-初始页面.png
02-填写收货信息.png
03-操作成功.png

Markdown 图片路径必须相对于当前文档正确引用；文档移动后要重新检查路径。图片应紧跟对应步骤，并配一句说明，不能只堆放图片。涉及硬件时，单独建立 工作台搭建/ 等子目录，并同时说明连接方式、使用位置和必要配置。

当连续操作较多、需要展示扫码动作、设备配合或页面状态变化时，可同时提供操作视频。视频用于帮助读者理解完整流程，文字步骤仍必须保留，不能只用视频替代关键规则和限制条件。

视频建议按以下路径保存：

docs/assets/<端>/<一级菜单>/<功能模块>/视频/

文件名使用两位数字加简短说明，与截图编号保持一致，例如 01-快速收货完整流程.mp4。文档中应在对应步骤附近引用视频，并注明适用场景、观看前提和关键注意事项；视频无法在当前 Markdown 渲染器播放时，提供可访问的视频链接或文件位置，并保留文字操作步骤。