Trang chủ Khám phá Trợ giúp
Đăng ký Đăng nhập
wuzilong
/
mtsd
1
0
Fork 0
Các tập tin Các vấn đề 0 Yêu cầu khéo về 0 Wiki
Branch: master
Branches Tags
mtsd
/
docs
/
叁强鲜配-系统操作手册-编制方案.md

叁强鲜配-系统操作手册-编制方案.md 16 KB
Permalink Lịch sử Raw

陇耘鲜达系统操作手册 — 编制方案（审核稿）

系统名称：陇耘鲜达（项目代号：叁强鲜配） 文档性质：实现目标、实现思路与实现规划的一体化说明，供内部/甲方编制负责人审核。 版本：v0.2（根据代码库验证与反馈修订） 日期：2026-05-07

1. 背景与范围

1.1 背景

为「陇耘鲜达」交付 系统操作手册，用于 甲方或合作方验收 场景：说明 Web 运营端与小程序（登录后按角色 — 客户 / 供应商 / 配送员 — 显示不同功能界面）在约定环境下的主要操作路径与界面行为，便于对照系统功能完成验收阅读或演示。

1.2 交付物形态

交付物 说明
主手册（Word，.docx） 分两部分：① Web 运营端；② 小程序端（同一应用按角色分为客户端、供应商端、配送员端三章）。正文 不出现 具体访问 URL、账号口令。
《验收环境说明》（独立 1 页，Word 或 PDF） 写明各端访问地址、演示用账号（可脱敏说明）、浏览器/微信版本、数据范围等；与主手册 同一版本号/日期，主手册封面或修订记录中引用该附件。

1.3 范围边界（已确认）

  • 功能范围：以系统 已实现 的功能为准，且菜单/入口须对对应角色 在界面上实际可见；仅有配置或路由但侧栏/主导航不可见的项 不写入。
  • Web 运营端视角：仅以 超级管理员 登录后的侧栏菜单树为准编写，不按区域管理员等拆多套菜单册。
  • 小程序（按角色区分）：小程序为单一应用，登录后根据角色（客户、供应商、配送员）显示不同功能界面；按 实际登录后可见的功能与入口 编写，仅收录界面实际出现的功能（如配送员端由运营人员分配任务，无抢单功能，则不写入抢单相关内容）。规则与 Web 端「可见才写」一致。
  • 运行环境说明：本地已具备演示条件时（如 Web http://localhost:3006/、H5 http://localhost:5173/），仅写入《验收环境说明》，主手册保持环境无关表述。

2. 实现目标

2.1 总体目标

产出结构清晰、可归档、可随版本迭代的 Word 操作手册 及 环境附件，使甲方在 不依赖口头讲解 的情况下，能够按文档理解各端菜单层级与核心操作流程，并可在约定环境中复现关键步骤。

2.2 可验收的细化目标

  1. 结构完整：主手册包含「Web 运营端」「小程序端（客户端 / 供应商端 / 配送员端）」两大部分，章节层级与 超级管理员侧栏 及 各角色实际登录后可见的功能入口 一致或可逐条对应。
  2. 口径一致：界面名称、按钮文案、状态名称与 当前交付版本 系统一致；改版时通过 版本号 + 修订记录 可追溯。
  3. 安全与合规：主正文不含生产敏感 URL 与口令；环境敏感信息 仅 出现在《验收环境说明》中，并注明用途与保密要求（由法务/项目负责人最终定稿）。
  4. 可维护：建议采用 Markdown 源稿 + 定稿转 Word 或统一模板，便于后续增量更新（具体见第 4 节）。
  5. 甲方阅读体验：关键流程采用「前置条件 → 操作步骤 → 预期结果」；必要时对不可逆操作、权限前提单独提示。

2.3 非目标（本期不承诺）

  • 不写 未实现 或 仅内部规划 的功能。
  • 不替代 合同技术附件 中的逐条功能规格；手册侧重 操作路径与界面说明。
  • 不承诺替代 7×24 运维手册 或 接口/数据库设计文档。

3. 实现思路

3.1 方法论

  1. 「可见菜单/功能」为唯一清单来源

    • Web：使用超级管理员账号登录，导出或抄录 侧栏完整菜单树（含二级、三级），与后端 sys_menu 中 is_visible、is_active 及前端过滤逻辑交叉核对，避免写入隐藏项。
    • 小程序：使用各角色账号分别登录，以 实际可见的功能入口、按钮、列表项 为纲。注意：不同角色看到的界面不同，必须逐角色走查；若某功能在代码中存在但该角色界面不可见（如配送员端代码中有抢单页面但实际无此入口），则 不写入。

  2. 先定目录，后填内容与截图

    • 目录与菜单 一一映射（无独立菜单的子功能归入父菜单章节）。
    • 每节模板：功能说明（1～3 句）→ 进入路径 → 操作步骤 → 预期结果 → 注意事项（可选）。

  3. 正文与环境分离

    • 主手册统一写「登录运营后台后」「在客户小程序首页」等，具体 URL、账号见《验收环境说明》。
    • 截图图注注明「界面以验收环境为准」；地址栏敏感信息按需打码。

  4. 成稿工具链（推荐）

    • 源稿：Markdown 分文件维护（按 Web / 客户 / 供应商 / 配送员拆分），便于 diff 与评审。
    • Word：通过 Pandoc 或公司模板合并为 .docx，再人工调整样式、页眉页脚、目录域。
    • 若无模板约束，可直接 Word 编写，但需约定 样式集（标题 1～3、正文、图题）以减少返工。

  5. 小程序呈现环境

    • 小程序为 uni-app 单一项目，编译为微信小程序及 H5（浏览器预览）。若截图基于 H5 本地预览（如 5173 端口），须在环境说明与图注中 明确写出，避免甲方在微信内找不到完全一致布局时产生争议。

  6. 功能验证原则

    • 所有功能描述必须通过 实际登录系统 后验证：以各角色账号登录，逐界面确认可见的功能、按钮、表单、列表项。代码中存在但界面不可见的功能 不写入手册（例如配送员端代码中有抢单模块，但实际配送任务由运营端分配，配送员界面无抢单入口，因此手册不涉及抢单内容）。

3.2 质量保障要点

  • 走查：编制完成后，由编制人按目录 逐条点验 系统，确认步骤与当前版本一致。
  • 交叉审阅：业务方核对业务规则描述，技术方核对菜单是否遗漏/是否含隐藏菜单。
  • 版本绑定：修订记录中注明「菜单快照日期」或「对应构建/标签」。

4. 实现规划

4.1 阶段划分

阶段 工作内容 主要产出
P0 准备 确认 Word 模板（页眉、Logo、编号）、确定 Pandoc/纯 Word 路径；搭建《验收环境说明》空白模板；约定截图分辨率与命名规则。 模板包、命名规范
P1 清单 超级管理员登录 Web，整理侧栏菜单树；各角色分别登录小程序，整理可见功能清单（以实际界面为准，非代码路由）；与代码/菜单表抽查对齐。 菜单-章节对照表（Excel/Markdown 均可）
P2 撰稿 按对照表逐章撰写；同步截取关键界面；缺业务含义的菜单补充向产品/研发 单次集中答疑 记录。 Markdown 源稿 + 图片资源目录
P3 汇编 合并为 Word；生成自动/手工目录；统一术语表；撰写封面、修订记录、适用范围。 主手册 .docx 初稿
P4 环境附件 填写《验收环境说明》（URL、账号、客户端版本、数据说明）；与主手册版本号对齐。 环境说明 .docx/.pdf
P5 评审与修订 内部评审 → 甲方预审（若需要）→ 修改闭环；定稿 v1.0 签字或邮件确认归档。 正式版交付包

4.2 建议工时量级（供审核参考，可按人力调整）

阶段 说明
P0～P1 约 1～2 人日（需逐页面核对约 50+ 页面与实际界面一致性）
P2 约 5～8 人日（Web ~15 页 + 小程序 ~34 页，含截图与步骤描述）
P3～P5 约 2～4 人日（50+ 页面的排版、目录生成、术语统一）

4.3 人员与依赖

  • 编制：熟悉系统操作的实施/产品/测试（可多人分章）。
  • 审核：业务负责人 + 技术负责人（菜单完整性）+ 对外接口人（甲方语气与脱敏）。
  • 依赖：稳定可登录的验收环境；三端小程序各至少一个演示账号（写在环境说明中）。

4.4 里程碑建议

  • M1：菜单-章节对照表通过审核。
  • M2：Markdown 全量初稿完成（可含「待补截图」占位）。
  • M3：Word 初稿 + 环境附件齐套，内部走查通过。
  • M4：v1.0 定稿交付。

5. 实际验证功能清单（2026-05-07 通过系统登录验证）

以下数据均通过实际登录系统（Web localhost:3006、H5 localhost:5173）逐角色验证，非代码静态分析结果。

5.1 Web 运营端（超级管理员 admin/admin123）

侧栏菜单树（共 6 组 / 15 个页面）：

工作台
  └─ 工作台（运营工作台）
       ├─ 区域 Tab（全部区域 / 兰州西区1 / 城东区域123 / 兰州东区 / 城西区域 / 城南区域）
       ├─ 配送时效预警提示
       ├─ 数据概览（客户总数 / 供应商数量 / 今日订单 / 待配送 / 今日交易额 / 新的报价）
       ├─ 近30日趋势（营业额 / 订单数折线图）
       ├─ 今日各区域（营业额+订单数柱状图 / 下单客户柱状图）
       └─ 最新订单列表

基础数据
  ├─ 区域管理
  ├─ 用户管理
  ├─ 商品参数
  ├─ 商品单位
  ├─ 商品分类
  └─ 商品管理

询价报价
  └─ 询价报价管理

订单管理
  ├─ 订单列表
  ├─ 商家结算管理
  └─ 客户结算管理

配送管理
  ├─ 配送列表
  └─ 时效预警

系统管理
  ├─ 系统设置
  └─ 接口日志

5.2 小程序 — 客户端（client01/123456）

导航方式：底部 TabBar（4 个 Tab）

首页（Tab）
  ├─ 商品分类侧栏 + 商品列表
  └─ 底部购物车浮层（已选商品数量 / 金额 / 去结算按钮）

订单（Tab）
  ├─ 状态筛选 Tab：全部 / 待支付 / 待收货 / 已完成 / 已取消
  └─ 订单列表

购物车（Tab）
  ├─ 收货地址选择（修改入口）
  ├─ 购物车商品列表
  └─ 结算操作

我的（Tab）
  ├─ 用户信息（演示客户甲 / 陇耘会员 / 城东区域123）
  ├─ 订单快捷入口：待支付 / 配送中 / 已完成
  ├─ 收货地址管理
  ├─ 修改密码
  ├─ 联系客服
  └─ 退出登录

5.3 小程序 — 供应商端（supplier01/123456）

导航方式：首页 Dashboard + 常用功能入口列表（无 TabBar）

供应商工作台
  ├─ 用户信息（演示供应商甲 / 城东区域123 / 退出登录）
  ├─ 统计卡片：待报价询价单 / 我的报价 / 待备货任务
  ├─ 常用功能入口：
  │    ├─ 询价单
  │    ├─ 我的报价
  │    ├─ 备货任务
  │    ├─ 价格清单
  │    ├─ 取货地址
  │    ├─ 设置头像
  │    ├─ 修改密码
  │    └─ 联系客服
  └─ 待处理备货任务列表

5.4 小程序 — 配送员端（deliver01/123456）

导航方式：首页 Dashboard + 功能入口（无 TabBar）

配送员工作台
  ├─ 用户信息（演示配送员甲 / 城东区域123 / 退出登录）
  ├─ 统计卡片：待取货 / 配送中 / 今日完成
  ├─ 常用功能入口：
  │    ├─ 设置头像
  │    ├─ 修改密码
  │    └─ 联系客服
  └─ 配送任务列表
       ├─ 搜索（单号 / 供应商 / 客户 / 联系人）
       └─ 状态筛选 Tab：待取货 / 配送中 / 已完成

⚠️ 已确认：配送员端无「抢单」功能入口。 配送任务由运营端分配，配送员仅查看和操作已分配的任务。代码中存在的抢单 API（/mini/deliverer/snatch/*）当前在界面不可见，不写入手册。

5.5 建议目录结构（基于实际验证数据）

主手册 — 陇耘鲜达系统操作手册

第一部分：Web 运营端
  1. 登录与工作台
     1.1 登录
     1.2 工作台概览（区域切换 / 预警提示 / 数据概览 / 趋势图表 / 最新订单）
  2. 基础数据管理
     2.1 区域管理
     2.2 用户管理
     2.3 商品参数
     2.4 商品单位
     2.5 商品分类
     2.6 商品管理
  3. 询价报价管理
  4. 订单管理
     4.1 订单列表
     4.2 商家结算管理
     4.3 客户结算管理
  5. 配送管理
     5.1 配送列表
     5.2 时效预警
  6. 系统管理
     6.1 系统设置
     6.2 接口日志

第二部分：小程序端
  7. 登录与账号
     7.1 登录操作
     7.2 用户协议与隐私政策
  8. 客户端
     8.1 首页（商品浏览与购物车）
     8.2 订单管理（下单 / 支付 / 查看订单）
     8.3 购物车（地址选择 / 结算）
     8.4 个人中心（地址管理 / 修改密码 / 联系客服）
  9. 供应商端
     9.1 工作台概览
     9.2 询价单管理
     9.3 报价管理
     9.4 备货任务
     9.5 价格清单
     9.6 取货地址管理
     9.7 个人设置（头像 / 密码 / 联系客服）
  10. 配送员端
     10.1 工作台概览
     10.2 配送任务（待取货 / 配送中 / 已完成）
     10.3 个人设置（头像 / 密码 / 联系客服）

附录A：术语表
附录B：修订记录
---
独立附件：《验收环境说明》

6. 审核用检查清单（供你打勾）

  • 交付物是否认可：主手册 Word + 独立《验收环境说明》？
  • 目标与非目标是否与合同/验收口径一致？
  • Web 端是否确认 仅超级管理员菜单？
  • 小程序是否确认 按角色分章 + 各端可见入口？
  • 配送员端是否确认 无抢单功能（仅运营端分配任务）？
  • 是否指定 Word 公司模板 或接受 Markdown 转 Word？
  • 截图环境是否统一为 H5 / 微信真机 之一并在附件声明？
  • 是否需要 中英双语 或 仅中文（当前方案默认仅中文）？
  • v1.0 签字人/确认方式（邮件/纸质）是否由你方指定？

6. 风险与假设

项 说明与应对
菜单与版本漂移 以修订记录绑定版本或日期；发版后安排 手册补丁版本。
H5 与微信表现不一致 环境说明与图注 强制声明 截图来源。
敏感模块（结算、权限） 描述以 操作与界面为准；涉密细则由业务与法务把关。
人力不足 优先保证 主流程章节 质量，次要菜单可「简述 + 指向界面字段说明」——若你方要求 不允许简写，则以对照表全量展开为准。

7. 需求追溯（对话结论摘要）

项 结论
读者 甲方或合作方验收
主手册中的 URL/账号 不写；单独《验收环境说明》
功能范围 全覆盖；仅 已实现且界面可见 的功能（以实际登录验证为准）
Web 端角色 超级管理员
小程序 单一应用，登录后按角色（客户、供应商、配送员）显示不同功能
本地演示 仅用于撰稿与截图；地址与账号进 附件，不进主手册正文
系统名称 陇耘鲜达（项目代号：叁强鲜配）
功能验证 必须实际登录各角色验证可见功能；代码存在但界面不可见的不写入

8. 修订记录

版本 日期 说明
v0.1 2026-05-07 初稿，供审核
v0.2 2026-05-07 根据代码库验证与反馈修订：系统名称统一为「陇耘鲜达」；小程序改为单一应用按角色区分；新增功能验证原则；修正工时估算
v0.3 2026-05-07 新增 §5 实际验证功能清单（通过系统登录逐角色验证）；新增建议目录结构；确认配送员无抢单功能

审核意见栏（可填于打印件或副本）

  • 审核人：
  • 日期：
  • 结论：□ 通过 □ 修改后再审
  • 意见摘要：