diff --git a/docs/_check_delivery_doc.py b/docs/_check_delivery_doc.py new file mode 100644 index 0000000..04e5167 --- /dev/null +++ b/docs/_check_delivery_doc.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +"""数据接入准备交付包(docs/数据接入准备_交付包.md)完整性检查。 + +检查项: +1. 必备章节齐全(交付物清单 / 接入确认清单 / 缺省策略 / 验收对照); +2. 交付物引用的文档/资产真实存在(#16/#17/#18/#19/#20/#27 成果); +3. EPIC #2 验收关键词存在(沸腾氯化炉 / LIMS / 能源计量 / 提前 2 周 / 缺省)。 + +用法:python _check_delivery_doc.py +""" +import os +import sys + +HERE = os.path.dirname(os.path.abspath(__file__)) +REPO_ROOT = os.path.dirname(HERE) +DOC_PATH = os.path.join(HERE, "数据接入准备_交付包.md") + +REQUIRED_SECTIONS = [ + "## 1. 交付物清单", + "## 2. 数据项接入确认清单", + "## 3. 缺省策略执行路径", + "## 5. 验收对照", +] + +# 交付物引用的关键文档/资产(需存在) +REFERENCED_PATHS = [ + "docs/DCS点表需求模板.md", + "docs/LIMS质检接口字段清单.md", + "docs/数据准备清单.md", + "docs/网络拓扑与隔离策略.md", + "docs/采集网只读隔离与网闸配置.md", + "templates/ti-cl4/point-dict/point_dict.default.csv", +] + +KEY_PHRASES = ["沸腾氯化炉", "精制还原", "LIMS", "能源计量", "提前 2 周", "缺省通用点位集"] + + +def main() -> int: + failures = [] + text = open(DOC_PATH, "r", encoding="utf-8").read() + + for sec in REQUIRED_SECTIONS: + if sec not in text: + failures.append(f"缺少必备章节:{sec}") + + for rel in REFERENCED_PATHS: + if not os.path.isfile(os.path.join(REPO_ROOT, rel)): + failures.append(f"交付物引用缺失:{rel}") + + for phrase in KEY_PHRASES: + if phrase not in text: + failures.append(f"缺少验收关键词:{phrase}") + + if failures: + print("FAIL") + for f in failures: + print(" -", f) + return 1 + print("OK: 章节/交付物引用/验收关键词校验通过") + return 0 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/docs/数据接入准备_交付包.md b/docs/数据接入准备_交付包.md new file mode 100644 index 0000000..774560f --- /dev/null +++ b/docs/数据接入准备_交付包.md @@ -0,0 +1,84 @@ +# 氯化车间数据接入准备 —— 交付包(M1) + +> 对应 EPIC #2「[M1] 氯化车间数据接入准备(DCS 点表 / LIMS 接口 / 数据准备清单)」: +> 向客户发出数据准备清单;确认**沸腾氯化炉 / 精制还原工段** DCS 点表、 +> **LIMS/质检数据接口**、**能源计量接口**; +> 缺省策略:点表延迟时启用**默认通用点位集**完成框架验证(PRD 13 章); +> 依赖客户配合,**提前 2 周**发出清单。 + +本交付包整合已完成的子任务交付物,形成可向客户执行的**数据接入准备成套包** +(EPIC 跟踪容器不单独计时,实际工作见各子 Issue)。 + +--- + +## 1. 交付物清单(子任务成果索引) + +| 数据项 | 交付物 | 来源子任务 | 状态 | +| --- | --- | --- | --- | +| DCS 点表需求模板 | `docs/DCS点表需求模板.md` | #16 | ✅ 已交付 | +| LIMS/质检接口字段与推送频率 | `docs/LIMS质检接口字段清单.md` | #17 | ✅ 已交付 | +| 数据准备清单(客户版+回执跟踪) | `docs/数据准备清单.md` | #18 | ✅ 已交付 | +| 采集网/工业环网/办公网拓扑与隔离 | `docs/网络拓扑与隔离策略.md` | #19 | ✅ 已交付 | +| 采集网只读隔离 + 网闸配置 | `docs/采集网只读隔离与网闸配置.md` | #27 | ✅ 已交付 | +| 缺省通用点位集(演示/框架验证) | `templates/ti-cl4/point-dict/`(point_dict.default.csv) | #20 | ✅ 已交付 | + +> 配套:点位字典 schema 与边缘网关采集(core/edge-gateway)、 +> 点表 CSV 9 列字段规范见 #16 文档 §3。 + +--- + +## 2. 数据项接入确认清单(向客户确认项) + +按 EPIC #2 验收要求,向客户确认以下三个接入项(配合《数据准备清单》#18 发出): + +| # | 确认项 | 范围 | 依赖模板/清单 | 交付验收 | +| --- | --- | --- | --- | --- | +| C1 | **沸腾氯化炉/精制还原工段 DCS 点表** | 炉温/炉压/氯气流量/加料比/液位等工艺测点 + 能源计量 | DCS点表需求模板.md(#16) | 点表 CSV 回传并校验通过 | +| C2 | **LIMS/质检数据接口** | 钛纯度、杂质(Fe/Si/Mg/Cl)、粒度;推送频率 | LIMS质检接口字段清单.md(#17) | 接口字段清单回传;或一期人工录入过渡 | +| C3 | **能源计量接口** | 电/蒸汽/纯水/称重(E-01、W-01 等) | DCS点表需求模板.md §4-5 | 计量点位纳入点表 | + +--- + +## 3. 缺省策略执行路径(PRD 13 章) + +**点表延迟时**(客户配合滞后): + +1. 启用 `templates/ti-cl4/point-dict/point_dict.default.csv`(#20 缺省通用点位集, + 600 点位 1Hz,对齐 PRD 5.1 验收基线); +2. 以缺省点位集完成**框架验证**:采集 → 数据总线 → 时序库 → 驾驶舱全链路; +3. 客户点表到位后:按 #16 字段规范导入 → 配置台校验 → 生成正式点位字典 → + 推送边缘网关加载(见 #27 只读隔离配置)→ 替换缺省集。 + +**LIMS 接口未定时**:一期人工录入/批量导入质量标签(#17 §6),二期补接口。 + +--- + +## 4. 时间表(客户配合节奏) + +| 时间点 | 事项 | 责任方 | +| --- | --- | --- | +| T-2 周 | 发出《数据准备清单》(#18)与各模板 | 我方项目经理/实施 | +| T-1 周 | 首轮催办(C1–C3 逐项确认) | 我方项目经理 | +| T-3 天 | 二次催办 + 风险升级 | 我方项目经理/产品 | +| T(M1 冻结) | 回执截止;未到位项启用 §3 缺省策略 | 双方 | +| T+1 周 | 数据接收校验与登记(#18 §6 跟踪机制) | 实施工程师 | + +--- + +## 5. 验收对照(EPIC #2 ↔ 交付物) + +| EPIC 验收要求 | 交付物 | 满足方式 | +| --- | --- | --- | +| 向客户发出数据准备清单 | `docs/数据准备清单.md`(#18) | 清单 + 回执单 + 跟踪机制 | +| 确认沸腾氯化炉/精制还原工段 DCS 点表 | §2 C1 + `DCS点表需求模板.md`(#16) | 字段规范 + 填表示例 + 校验 | +| 确认 LIMS/质检数据接口 | §2 C2 + `LIMS质检接口字段清单.md`(#17) | 接口字段 + 推送频率 + 人工过渡 | +| 确认能源计量接口 | §2 C3 | 计量点位纳入点表(#16 §6 示例) | +| 缺省策略:点表延迟启用默认点位集 | §3 + `templates/ti-cl4/point-dict/`(#20) | 600 点位缺省集框架验证 | + +--- + +## 6. 关联 + +- 子任务:#16 / #17 / #18 / #19 / #20 / #27; +- PRD 5.1(数据接入)、13 章(缺省策略与依赖矩阵); +- 模板:Template-Ti 一期(template-ti),与树脂模板(#13/#82-#85)并行。