From 6b5e6b29251c46d98c8dc57fe2588492dfba87be Mon Sep 17 00:00:00 2001 From: cai <cai@nbcai.cc> Date: Wed, 03 Jun 2026 23:22:15 +0800 Subject: [PATCH] docs: 补充数据目录导读 --- data/目录导读.md | 26 ++++++++++++++++++++++++++ common/data-doc/目录导读.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 0 deletions(-) diff --git "a/common/data-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/common/data-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" new file mode 100644 index 0000000..af2393c --- /dev/null +++ "b/common/data-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -0,0 +1,32 @@ +# 数据体系目录导读 + +创建人员:Codex +文件职责:说明 `common/data-doc` 下数据体系公共规范、模板和创建指南的用途,并确保该目录可被 Git 跟踪。 +管理规范/模板:../../全局规范.md;../../体系创建流程.md;../../全局存储体系.md;../../全局数据格式.md。 +引用文件:../../全局存储体系.md;../../全局数据格式.md。 +记录方式:目录导读;新增、删除或调整数据体系公共文档时同步更新。 + +## 1. 体系定位 + +数据体系用于管理项目内数据来源、数据格式、数据账本、数据质量检查和数据使用边界。 + +数据体系不替代实验体系、案例分析体系或开发体系。它负责维护数据口径和数据证据链,其他体系在使用数据时应引用数据体系中的说明、索引和检查结果。 + +## 2. 当前状态 + +当前目录暂未放置完整数据体系模板,仅保留本导读文件用于占位和 Git 跟踪。 + +后续补充数据体系时,建议至少包含: + +1. 数据体系规范。 +2. 数据环境创建指南。 +3. 数据索引或数据清单模板。 +4. 数据质量检查记录模板。 +5. 数据问题记录模板。 + +## 3. 使用原则 + +1. 项目内启用数据体系时,应先明确数据来源、更新频率、字段口径和权限边界。 +2. 数据文件、数据索引和数据质量检查结果应可追溯。 +3. 临时数据、缓存和生成物不得混入公共模板目录。 +4. 数据体系文档与全局数据规范冲突时,以 `全局存储体系.md` 和 `全局数据格式.md` 为准。 diff --git "a/data/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/data/\347\233\256\345\275\225\345\257\274\350\257\273.md" new file mode 100644 index 0000000..9dbe2d5 --- /dev/null +++ "b/data/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -0,0 +1,26 @@ +# data 目录导读 + +创建人员:Codex +文件职责:说明 `data` 目录的定位,并确保该目录可被 Git 跟踪。 +管理规范/模板:../全局规范.md;../全局存储体系.md;../全局数据格式.md。 +引用文件:../全局存储体系.md;../全局数据格式.md。 +记录方式:目录导读;新增、删除或调整全局数据材料时同步更新。 + +## 1. 目录定位 + +本目录用于保存管理系统级别的全局统一数据源、数据索引材料或跨项目可复用的数据说明。 + +具体项目产生的数据不应直接写入本目录,应优先放入项目自己的数据目录,并在需要时通过索引或清单引用。 + +## 2. 当前状态 + +当前目录暂不放置具体数据文件,仅保留本导读文件用于占位和 Git 跟踪。 + +后续新增全局数据材料时,应先确认其是否满足跨项目复用、统一口径和长期维护要求。 + +## 3. 使用原则 + +1. 不存放临时文件、缓存文件或单项目私有数据。 +2. 不存放未说明来源、字段口径和更新时间的数据。 +3. 新增数据材料时,应同步补充数据来源、字段说明、维护人和使用边界。 +4. 与 `全局存储体系.md`、`全局数据格式.md` 冲突时,以全局规范文件为准。 -- Gitblit v1.9.3