57 lines
2.8 KiB
Markdown
57 lines
2.8 KiB
Markdown
# 审计记录：docs/bd_manual + docs/dictionary → docs/database 合并
|
||
|
||
- 日期：2026-02-15（Asia/Shanghai）
|
||
- Prompt：用户要求将 `docs/bd_manual` 和 `docs/dictionary` 合并为统一路径 `docs/database/`，按数据层分目录
|
||
|
||
## 直接原因
|
||
|
||
两个目录都是数据库相关文档，但分散在不同路径下，对新人不友好且维护时容易遗漏。合并为 `docs/database/` 统一入口，原 dictionary 的概览文件放入 `overview/` 子目录，表级文档按 ODS/DWD/DWS/ETL_Admin 分层。
|
||
|
||
## 变更类型
|
||
|
||
纯文档/配置路径重组，无逻辑改动、无 DB schema 变更、无业务规则变化。
|
||
|
||
## 修改文件清单
|
||
|
||
### 目录操作
|
||
- `docs/bd_manual/` → 内容复制到 `docs/database/`，旧目录已删除
|
||
- `docs/dictionary/` → 内容复制到 `docs/database/overview/`，旧目录已删除
|
||
- `docs/database/main/`、`docs/database/Ex/`、`docs/database/changes/`（之前未完成迁移的残留）已清理
|
||
|
||
### 路径引用更新
|
||
- `docs/database/README.md` — 重写为新结构索引
|
||
- `docs/database/overview/ods_tables_dictionary.md` — 内部链接更新
|
||
- `docs/database/ODS/changes/2026-02-13_ddl_sync_ods.md` — 引用路径
|
||
- `docs/database/DWD/changes/2026-02-13_ddl_sync_dwd.md` — 引用路径
|
||
- `docs/database/DWD/changes/20260214_drop_dwd_settle_list.md` — 引用路径
|
||
- `docs/database/DWS/changes/2026-02-13_ddl_sync_dws.md` — 引用路径
|
||
- `docs/README.md` — 子目录索引表
|
||
- `scripts/validate_bd_manual.py` — `BD_MANUAL_ROOT` 和 `ODS_DICT_PATH` 常量
|
||
- `.kiro/steering/governance.md` — 审计产物路径
|
||
- `.kiro/steering/db-docs.md` — BD 手册目录路径
|
||
- `.kiro/skills/bd-manual-db-docs/SKILL.md` — description + 输出路径
|
||
- `.kiro/skills/steering-readme-maintainer/SKILL.md` — 联动规则引用
|
||
- `.kiro/hooks/db-docs-sync.kiro.hook` — description + prompt
|
||
- `.kiro/hooks/db-schema-doc-enforcer.kiro.hook` — description + prompt
|
||
|
||
### 未修改（历史记录，保留原样）
|
||
- `docs/开发笔记/DWS/记录1.md` — 开发备忘历史
|
||
- `.kiro/specs/bd-manual-docs-consolidation/` — 已完成的 spec 历史
|
||
|
||
## 风险点
|
||
|
||
- 风险极低：纯路径重组，无运行时代码变更
|
||
- 如果有外部工具/脚本硬编码了旧路径，需要手动更新
|
||
|
||
## 回滚要点
|
||
|
||
- git revert 即可恢复旧目录结构
|
||
- 或手动将 `docs/database/` 内容拆回 `docs/bd_manual/` + `docs/dictionary/`
|
||
|
||
## 验证步骤
|
||
|
||
1. 确认旧目录不存在：`Test-Path docs/bd_manual` → False，`Test-Path docs/dictionary` → False
|
||
2. 确认新结构完整：`docs/database/` 下有 ODS/DWD/DWS/ETL_Admin/overview 五个子目录
|
||
3. 全文搜索 `docs/bd_manual` 确认活跃文件中无残留引用（specs/开发笔记除外）
|
||
4. 运行 `python scripts/validate_bd_manual.py --help` 确认脚本路径常量正确
|