| 项 | 说明 |
|---|---|
| 模块名称 | 设备实施作业标准管理 |
| 目标 | 对设备实施作业标准进行增删改查、附件与封面管理,并与知识库同步、发布生命周期衔接 |
| 关联系统 | 业务后台、知识库 |
| 流程修订依据 | 业务状态与生命周期与《养殖标准管理功能需求》对齐(上架维度 × 知识库同步维度;下架回流、删除与知识库通知等语义一致) |
本文档仅描述本模块设备实施作业标准管理的功能需求与业务规则,不涉及库表结构、接口路径与字段命名等实现设计;与其它业务模块文档相互独立。
标准类型不再使用数字枚举,持久化与接口传参均为 资讯类别编码(varchar)。可选范围由 资讯类别 子节点维护,本模块取 parentCode=001、categoryType=3 下的子项(与《资讯类别》数据一致,名称以库表为准):
| 编码 | 名称(示例) |
|---|---|
001007 |
设备操作 |
001008 |
设备保养 |
001009 |
设备排障 |
001010 |
设备维修 |
新增/修改保存时,编码须在上述有效集合内;列表筛选为 编码精确匹配。
业务状态拆成 两个正交维度,避免出现单一枚举无法表达的非法组合;具体如何在系统中持久化由实现阶段决定,本文档只约束语义与合法组合。
| 取值 | 含义概要 |
|---|---|
| 未发布 | 未对外发布阶段:含新建草稿、未同步下编辑、已从已发布下架回流等;仅未发布且未同步时可编辑;同步 / 移出 / 发布 / 删除规则见第 4~5 章 |
| 已发布 | 对外可见或可检索(与产品定义一致);不允许修改;不可直接删除,须先执行 下架 |
下架: 执行「下架」后,业务侧不将本条单独持久化为「已下架」终态。下架完成后,上架状态回到 未发布,知识库同步状态为 已同步。
产品定论(与养殖标准一致): 下架后知识库内仍保留与本标准对应的可编辑副本(条目不删除,可与「对外发布 / 检索可见」解耦),业务侧稳态为 未发布 + 已同步,允许直接再次发布;若需改内容须先 移出知识库 → 未同步下编辑 → 再同步,无须新建一条设备实施作业标准。
若历史版本或数据字典曾使用「已下架」枚举仅作兼容或审计展示,须在实现说明中与「下架回流 = 未发布 + 已同步」的关系写清,避免与当前流程冲突。
| 取值 | 含义概要 |
|---|---|
| 未同步 | 知识库中无对应有效条目(或已移出);在满足矩阵规则下可执行手动「同步知识库」(仅当上架状态为 未发布) |
| 已同步 | 知识库侧已有与本条对应的条目;业务侧禁止编辑(须先移出后再改);未发布时可 发布、移出知识库 |
已同步状态下若要改内容: 须 移出知识库 → 未同步 下完成修改 → 再 同步知识库 → 已同步。
「移出知识库」见 4.7:执行后须将本维度置为 未同步。
以下组合允许作为稳态存在;其余组合(例如 已发布 + 未同步)视为 非法,不得在业务流程中出现。
| 上架状态 | 知识库同步 | 说明 |
|---|---|---|
| 未发布 | 未同步 | 初始或移出后;可手动同步、可编辑;未同步条件下允许删除(见 4.4) |
| 未发布 | 已同步 | 已入库(含手动同步、或已发布下架回流);不可编辑、可发布、可移出;删除规则见 4.4 |
| 已发布 | 已同步 | 发布的前提为已同步(4.8);对外展示中,不可改、不可删,仅可下架 |
下架 vs 移出: 下架不删除知识库条目,库内保留可编辑副本,业务 知识库同步 仍为已同步;若需从库内彻底清除条目,须在回到 未发布 + 已同步 后主动执行 移出知识库(4.7)。
下列顺序描述典型闭环,便于评审与培训;具体操作禁忌以 第 5 章矩阵 为准。
| 字段 | 规则 |
|---|---|
| 标准名称 | 必填;长度 1~20 个字符(字符计数规则与项目全局一致,如按 Unicode 字符数或字节长度须单独约定) |
| 标准类型 | 必填;单选,取值须为第 2.1 节所列资讯类别编码之一 |
| 标准简介 | 选填;若有内容,长度不超过 50 字(字数口径与项目全局一致,如是否含标点、中英文计数方式) |
| 标准内容 | 必填;通过单个附件上传;允许后缀:pdf、md、doc、docx、xls、xlsx、ppt、pptx;单文件 ≤ 30 MB |
| 封面 | 选填;通过单个图片上传;允许后缀:jpg、jpeg、png(若产品要求支持 webp 等可追加);单文件 ≤ 10 MB |
必填字段汇总: 标准名称、标准类型、标准内容。
校验:
须校验文件类型(如后缀与白名单 / MIME 策略以项目安全规范为准)一致,大小超限给出可区分的错误分类提示;若业务要求标准名称在适用范围(如租户 / 组织)内唯一,应在评审时单独约定并写入本节。
初始状态: 新建成功后,上架状态为 未发布,知识库同步状态为 未同步(除非产品与养殖标准另有统一的初始化规则)。
列表宜展示与运维相关的状态信息(如上架状态、知识库同步状态),便于用户理解可执行操作。
发布
下架
下架完成后并入 未发布且已同步 行理解。
| 当前状态(上架 × 知识库) | 修改 | 同步知识库 | 移出知识库 | 发布 | 下架 | 删除 |
|---|---|---|---|---|---|---|
| 未发布且未同步 | ✓ | ✓ | — | — | — | ✓ |
| 未发布且已同步 | ✗ | — | ✓ | ✓ | — | ✗(须先移出变为未同步,或删除流程联动移出/删库) |
| 已发布且已同步 | ✗ | — | — | — | ✓(回流为未发布+已同步) | ✗ |
补充: 从「已发布」下架后,记录进入 未发布且已同步,操作权限按上表第二行执行。
code、msg、data),与项目全局规范一致。| 类别 | 建议 |
|---|---|
| 权限 | 菜单与按钮级权限:新增、编辑、删除、发布、下架、同步、移出等是否分角色 |
| 审计 | 关键操作记录操作日志(发布、下架、手动同步、移出、删除) |
| 安全 | 上传文件类型校验、存储访问控制、下载鉴权 |
| 性能 | 列表避免低效查询模式;大附件若后续有需要再扩展直传或分片 |
设备实施作业标准管理功能需求-草稿.md)001007~001010 等,parentCode=001、categoryType=3);展示名称与资讯类别子节点一致(如设备保养)。设备实施作业标准管理功能需求-草稿.md 及养殖/饲喂等标准模块对齐。