页面数据字典规范(字段行为模式版)¶
适用基线:测试环境目标 /
dev分支 / 2026-07-22。 目标:让读者通过正式文档理解字段如何参与底层业务逻辑——取值分流、选择范围、字段联动、回填与锁定、数量精度、状态门禁等——而不是恢复技术字段清单,也不是只写字典项。 写作约定见工作台《实体说明页标准模板》(project-docs/00-需关注/);历史《字段业务语义建设计划》已归档至project-docs/90-归档/01-历史总控过程/(均不进站点导航)。
本规范解决什么问题¶
业务页字段说明若只列「字典项 / 弹窗选择」,读者仍答不出:选不同值会走哪条路径、为什么选不到、改上游会不会清空下游、某状态下能不能点某个按钮。本规范用 P1–P14 行为模式 统一写法,让正式页写「字段如何改变能选什么 / 能填什么 / 能做什么 / 算什么 / 流转到哪」。
读完应能判断:写业务页时该用哪张专项表、主文档与维护参考如何拆分、验收时按哪几条核对;本页是写法规范,不是某一张业务单的作业说明。
如何使用本页¶
| 你的目的 | 建议做法 |
|---|---|
| 理解「行为语义」写什么、禁写什么 | 先读「写什么、不写什么」与完备标准五问 |
| 写业务页时引用 | 按 P1–P14 归类 → 主文档写主线关键项 → 维护参考补总表/专项表;跨页通例链 02-业务模型 共享页 |
| 对照验收 / 互审 | 直接用文末「验收清单」;选择器必查范围,字典必查取值影响 |
| 排障时对照字段行为 | 先定位模式(选择器 / 级联 / 门禁 / 精度),再回业务页专项表;通例见选择器、库位级联、库存粒度页 |
共享通例(勿在业务页重复空表):通用选择器过滤惯例、库位与仓储级联惯例、库存管理精度与唯一粒度。
1. 写什么、不写什么¶
正式 docs/ 应写 |
正式页禁止写入 |
|---|---|
| 字段在业务中的作用与行为影响 | DDL / DO / DTO / VO / 表名 / 列名 |
| 取值如何分流到不同功能路径 | 源码路径、类名、权限注解原文 |
| 选择器可选范围与依赖 | 未证实的技术字段名或 API path |
| 联动、回填、锁定、换算、门禁 | “可能有影响”而无功能落点的空话 |
| 错选/漏选的业务后果 | 把内部字段证据底稿原样贴入 |
判定口诀:会改变“能选什么 / 能填什么 / 能做什么 / 算什么 / 流转到哪”的字段,都必须说明;纯展示、纯审计字段可省略或一行澄清“系统维护、勿导入”。
完备标准(读者只看正式页应能回答):
- 这个字段/配置点在系统里起什么作用?
- 取值或可选范围是什么?依赖哪些前置字段/状态/权限?
- 改变它之后,哪些下游字段会清空、重算、锁定或禁止?
- 某状态下允许/禁止哪些动作?
- 错选、漏选或绕过限制会怎样?
未证实内容标 ❓ 待确认,或登记工作台《问题与待确认总账》,禁止脑补。
2. 字段行为模式清单(P1–P14)¶
写作前先归类。同一字段可兼属多模式;以读者最易误解的行为为主表,其余用列或附注补全。
| 模式 | 行为模式 | 典型例子 | 读者必须能回答的问题 | 推荐专项表 |
|---|---|---|---|---|
| P1 | 字典 / 枚举 / 开关 | 物料类型、库存状态、是否可采购 | 选不同值时,哪些功能行为不同? | 取值影响矩阵 |
| P2 | 受限选择器 | 选物料、库位、仓库、供应商、来源单 | 为什么不是全量?过滤依赖什么?带回什么? | 选择器范围表 |
| P3 | 库存/余额类选择器 | 选库存余额、包装、批次、托盘 | 按什么粒度过滤?可用量口径?选后锁定什么? | 选择器范围表 + 粒度说明 |
| P4 | 级联 / 依赖字段 | 先仓库再库区/库位;先物料再包装 | 上游变更后下游如何清空/重算/禁止? | 联动链表 |
| P5 | 系统回填 / 只读带出 | 选来源单后带供应商、单位 | 哪些可改、哪些锁定?冲突以谁为准? | 回填与锁定表 |
| P6 | 身份键 / 业务键 | 物料号、单据号、关系唯一键 | 可否改码?重复如何拦截?被引用后能否删? | 语义总表 + 变更风险 |
| P7 | 数量 / 单位 / 换算 | 收货数量、包装数量、替代单位 | 按哪个单位记账?如何换算?超收欠收? | 数量与换算表 |
| P8 | 管理精度 / 采集维度 | 批次、包装、托盘、序列号开关 | 现场必须扫/录什么?缺了能否完成? | 精度与采集表 |
| P9 | 状态 / 动作门禁 | 单据状态、任务状态 | 某状态允许哪些动作?谁触发迁移? | 状态-动作表 |
| P10 | 有效期 / 时间窗 | 生效失效、保质天数 | 过期后选择器是否过滤?业务是否拒绝? | 语义表或时间窗表 |
| P11 | 默认值 / 优先级 / 唯一默认 | 默认包装、默认库位、默认月台 | 多个候选如何取默认?能否并存多个默认? | 语义总表 |
| P12 | 策略引用 / 规则挂接 | 业务类型、单据设置、规则条件 | 引用后如何改变执行路径、库存事务、打印、编号? | 策略影响表(可与 P1 合并) |
| P13 | 权限 / 组织范围投影 | 工厂、部门、货主、数据权限 | 可见/可选范围如何被组织与权限裁剪? | 选择器范围表(增权限维) |
| P14 | 展示-only / 审计 | 创建人、更新时间 | 一般不写长说明;若被误当可维护字段,需一句澄清 | 语义表一行即可 |
3. 内容模型与表头¶
3.1 主文档:关键字段业务角色¶
| 字段/配置点 | 行为模式 | 在系统中的作用 | 关键行为要点(取值/范围/联动/门禁) | 维护或操作时要警惕什么 |
|---|---|---|---|---|
主文档只写主线关键项;完整语义放维护参考(或单文档的语义章节)。
3.2 维护参考:字段业务语义总表¶
| 字段(中文业务名) | 行为模式 | 业务作用 | 谁在何时维护/选择 | 业务约束摘要 | 影响哪些功能 | 变更或错选风险 |
|---|---|---|---|---|---|---|
「业务约束摘要」按模式写一句人话,例如:
- P1:取值来自某某字典,与某某开关互斥
- P2:仅可选「可用 + 可采购 + 当前供应商已绑定」的物料
- P4:随仓库变化而重置
3.3 P1:取值影响矩阵¶
| 取值 | 业务含义 | 影响的功能或流程 | 系统行为变化 | 错选/漏选后果 |
|---|---|---|---|---|
3.4 P2 / P3 / P13:选择器范围表¶
| 选择字段 | 选择对象 | 可选范围(必须写清) | 范围依赖的前置字段/状态/权限 | 选中后带回或锁定什么 | 选不到时通常原因 |
|---|---|---|---|---|---|
库存余额选择器额外写清:过滤粒度(物料/批次/托盘/包装/库位/库存状态等)与可用量口径。只写“弹窗选物料”视为未完成。
3.5 P4:联动链表¶
| 上游字段变化 | 受影响下游字段 | 系统行为(清空/重算/禁止/保持) | 业务原因 |
|---|---|---|---|
3.6 P5:回填与锁定表¶
| 触发选择 | 回填字段 | 可改/锁定 | 锁定解除条件 | 与手工录入冲突时以谁为准 |
|---|---|---|---|---|
3.7 P7:数量与换算表¶
| 数量字段 | 计量单位来源 | 换算关系 | 允许差异/超收欠收 | 记账落到哪一库存结果 |
|---|---|---|---|---|
3.8 P8:精度与采集表¶
| 精度/维度 | 何时必须采集 | 采集入口(Web/PDA) | 缺失时能否完成 | 对库存唯一粒度的影响 |
|---|---|---|---|---|
3.9 P9:状态-动作表¶
| 当前状态 | 允许动作 | 前置检查 | 成功后的状态/下游影响 | 禁止时的业务原因 |
|---|---|---|---|---|
可与主流程节配合,避免空表重复。具体状态编码未证实前,只写已知动作与业务结果,并标 ❓ 待确认。
3.10 P10 / P11 / P12¶
写入语义总表或短表即可;跨页重复的字典、选择器惯例、库位级联、库存粒度见 主数据治理模型、库存管理精度与唯一粒度 及后续共享语义页。
4. 正例与反例¶
4.1 P1 正例(物料用途开关)¶
| 取值 | 业务含义 | 影响的功能或流程 | 系统行为变化 | 错选/漏选后果 |
|---|---|---|---|---|
| 可采购 = 是 | 物料允许走采购获取路径 | 采购订单、采购收货等选物料场景 | ❓ 待确认:各业务选择器是否按此开关过滤 | 需要采购却关开关 → 现场选不到或建单后无法闭环 |
| 可采购 = 否 | 不作为采购对象 | 同上 | ❓ 待确认过滤时点 | 误关导致在途采购无法匹配正确物料 |
4.2 P1 反例¶
- 只写「物料类型为字典字段」——未说明选不同值后管控属性/有效天数等如何变化。
- 写「影响后续业务」——未点名采购收货、库存、BOM 等具体功能。
4.3 P2 正例(采购收货-来源采购订单)¶
| 选择字段 | 选择对象 | 可选范围 | 范围依赖 | 选中后带回或锁定 | 选不到时通常原因 |
|---|---|---|---|---|---|
| 来源采购订单 | 采购订单 | 已发布,且符合当前 ERP 订单类型要求的订单 | 业务类型/订单类型配置;❓ 数据权限是否再裁剪待确认 | 带回供应商、订单类型及可收货明细等;供应商等信息通常锁定 | 订单未发布、类型不符、已关闭/无剩余可收、不在权限范围 |
4.4 P2 反例(视为未完成)¶
- 「物料:弹窗选择物料」——无过滤范围、无依赖、无带回说明。
- 「库位:从库位主数据选择」——未写是否按仓库/库区/可用状态过滤。
4.5 P4 / P5 正例摘要¶
- P4:变更仓库 → 清空已选库区/库位(禁止保留跨仓库位)。
- P5:选来源单后回填供应商 = 锁定;计划数量 = 可改(受任务配置约束);冲突时以系统带回值为初始值,手工改写需符合任务开关。
5. 页面落点与拆分¶
| 内容 | 落点 |
|---|---|
| 主线关键项 | 主文档「关键字段业务角色」 |
| 语义总表 + 本页实际需要的专项表 | 维护与查询参考;未拆页则合并到主文档语义章节 |
| 专项表过长打断操作说明 | 可拆 <主文档名>-字段业务语义.md,主/参考页保留摘要 + 链接 |
| 技术核对 | 内部资料(仅作者,不进培训正文) |
无某模式时,在语义章节显式写一句「本页无 P3/P8」等,避免误判遗漏。
跨页复用(≥3 页重复)的规则上收到 docs/02-业务模型/,业务页只保留差异 + 链接。
6. 与内部字段证据的边界¶
| 层次 | 读者 | 内容 |
|---|---|---|
| 正式业务页 | 业务、培训、实施 | 行为语义、影响、约束、待确认业务结论 |
| 字段证据底稿 | 文档维护、产品、研发 | 技术名映射、DDL/VO 差异、接口与权限取证 |
正式页引用差距时只用 GAP-xxx / 业务待确认编号,不展开源码证据。
7. 单页写作 SOP¶
- 判断单文档或主文档 + 维护参考。
- 列出所有行为相关字段(忽略纯展示/审计,或一行澄清)。
- 按 P1–P14 归类(可多标签)。
- 主文档只写主线关键项(带模式列)。
- 参考页写语义总表。
- 按页内实际模式补专项表(有选择器必写范围;有字典必写矩阵;有联动必写链表)。
- 未证实标记并登记总账。
- 过验收清单,再
mkdocs build。
8. 验收清单(每页复用)¶
- 是否先做了行为模式归类(不是只盯着字典)?
- 每个 P2/P3 选择器是否写清可选范围与依赖?
- 每个 P1 分流字段是否有取值 → 功能影响?
- 每个 P4 是否写清上游变化对下游的处理?
- 每个 P5 是否写清回填 / 可改 / 锁定?
- P7 / P8 / P9 若存在是否有对应表或等价说明?
- 影响是否点名到具体模块 / 动作?
- 有无技术证据泄漏?未证实是否标记?
分派完成标准:其他人员无需查看源码,即可判断“能否创建、能否修改、能选什么、改了会影响什么、某状态能做什么、如何追溯”。未经证实的内容不得伪装为当前规则。