工业miniAPP开发赛项SRS V4.0（完整版·P0/P1/P2全量合并）

文档说明

本文档为工业miniAPP开发赛项的软件需求规格说明书（SRS）V4.0终极版，合并V3.0全量需求与V4.0分级规则，既保留完整业务场景覆盖，又明确开发优先级（P0=MVP核心，P1=迭代补充，P2=优化扩展），确保“初期聚焦核心、后期逐步扩展”，同时满足需求的详尽性与落地性。

一、核心业务需求（全量合并+分级标注）

1.1 设备管理模块

1.1.1 基础信息管理

1.1.2 交互与接口规则

• P0：设备状态变更后，工艺设计页面通过WebSocket实时同步（≤5s/次），网络中断时30s轮询，同步失败提示“数据同步失败，请刷新”

• P0：核心接口：/api/equipments/create（新增）、/api/equipments/status（状态修改）、/api/equipments/find（查询）

• P1：维保接口：/api/equipment/maintain/create（工单创建）、/api/equipment/maintain/complete（工单完成）

• P1：批量接口：/api/equipments/batch/update（批量修改）、/api/equipments/import（批量导入）

• P2：共享接口：/api/equipments/share/config（共享配置）、/api/equipments/archive/query（归档查询）

1.2 物料管理模块

1.2.1 基础信息与BOM管理

1.2.2 交互与接口规则

• P0：物料分类支持拖拽调整层级，删除分类需校验无关联物料

• P0：核心接口：/api/parts/create（新增）、/api/parts/bom/create（BOM关联）、/api/parts/version/saveAs（版本升版）

• P1：库存接口：/api/parts/stock/warn（预警配置）、/api/parts/purchase/create（采购申请单）

• P1：批次接口：/api/parts/batch/create（批次创建）、/api/parts/batch/out（批次出库）

• P2：共享接口：/api/parts/share/config（共享配置）、/api/parts/archive/restore（归档恢复）

1.3 工序管理模块

1.3.1 基础配置与约束管理

1.3.2 交互与接口规则

• P0：核心接口：/api/procedures/find（查询）、/api/procedures/equipment/bind（设备关联）

• P1：约束接口：/api/procedures/duration/set（时长设置）、/api/procedures/dependency/set（依赖配置）

• P2：模板接口：/api/procedures/template/save（模板保存）、/api/procedures/template/use（模板复用）

1.4 工艺管理模块

1.4.1 工艺设计与状态流转

1.4.2 交互与接口规则

• P0：工艺画布拖拽帧率≥25fps，资源池加载采用本地缓存（有效期10min）

• P0：核心接口：/api/plans/create（新增）、/api/plans/submit（提交）、/api/plans/resource/bind（资源关联）

• P1：派工接口：/api/plans/workorder/bind（工单关联）、/api/plans/change/apply（变更申请）

• P2：优化接口：/api/plans/log/query（执行日志）、/api/plans/template/save（模板保存）

1.5 跨模块联动核心规则（全分级适用）

1. 设备-工艺联动：设备状态变更后，工艺资源池实时同步，非RUNNING设备不展示在拖拽列表

2. 物料-工艺联动：工艺提交时校验物料库存，扣减库存与工艺状态更新原子执行（失败则回滚）

3. 工序-工艺联动：工艺中的工序需按依赖顺序执行，拖拽时强制校验，生产工单同步遵循依赖规则

二、接口设计规范（全量合并+分级适配）

2.1 通用规则（全分级适用）

2.1.1 请求/响应格式

• 所有接口统一POST方法，Content-Type=application/json

• 响应格式标准化：
  

  {
    "code": "0000", // 0000=成功，其他为错误码
    "msg": "操作成功", // 错误时返回具体原因
    "data": {}, // 业务数据体
    "total": 0, // 分页总数（非分页为0）
    "requestId": "req123456" // 唯一请求ID，用于日志排查
  }

• 分页参数：pageNum（默认1）、pageSize（默认20，最大100）

• 排序参数：sort={"字段名":"ASC/DESC"}（例：sort={"equipmentCode":"ASC"}）

2.1.2 错误码体系（全量）

2.2 核心接口全量清单（按模块+优先级）

2.2.1 P0核心接口（MVP必实现）

2.2.2 P1扩展接口（迭代补充）

2.2.3 P2优化接口（后期扩展）

三、非功能需求（全量合并+分级标注）

3.1 性能需求

3.2 易用性需求

3.3 安全需求

3.4 兼容性需求

四、权限与数据权限设计（全量）

4.1 角色-权限矩阵（全量角色）

4.2 数据权限规则

五、运维与监控需求（全量）

5.1 日志规范

5.2 监控与备份

六、测试与验收标准（全量+分级）

6.1 功能验收用例（核心示例）

6.2 非功能验收标准

七、开发优先级与迭代规划（全量合并）

7.1 开发阶段划分

7.2 需求变更流程（全量）

1. 需求提出人提交《需求变更申请单》（含变更原因、影响范围、优先级）；

2. 评审组（产品+开发+测试）评审，确认是否接受变更；

3. 接受变更后，更新SRS文档（标注变更记录），同步至所有相关人员；

4. 开发/测试根据更新后的SRS调整方案，重新评估工作量。

八、术语表（全量）

总结（V4.0终极版核心价值）

1. 全量覆盖：合并V3.0与V4.0所有需求，包含“基础管理→业务联动→场景扩展→体验优化”全链路；

2. 分级明确：每个功能标注P0/P1/P2优先级，既满足大赛MVP开发要求，又为后续扩展预留空间；

3. 落地性强：补充详尽的接口示例、错误码、验收用例，直接指导开发、测试、验收全流程；

4. 无歧义：统一术语定义、数据格式、交互规则，避免前后端/开发团队理解偏差。

如需进一步落地，可基于此文档生成《MVP阶段开发任务分解表》《接口调用手册》《测试用例集》等衍生文档，如需我协助生成某类文档，可直接告知！