Files
Neo-ZQYY/docs/audit/changes/2026-02-15__docs-devnotes-index-cleanup.md

2.1 KiB
Raw Permalink Blame History

审计记录docs/index + docs/开发笔记 清理与路径整合

  • 日期2026-02-15Asia/Shanghai
  • Prompt用户要求整理 docs/index/docs/开发笔记/ 路径,清理过期文件,更新引用
  • 风险等级:低(纯文档重组 + 脚本路径更新,无业务逻辑变更)

直接原因

docs/index/ 仅含一个文件,更适合归入 docs/database/DWS/docs/开发笔记/ 内容混杂,需分拣保留有价值文件、删除过期内容。

变更摘要

文件移动

  • docs/index/index_algorithm_cn.mddocs/database/DWS/index_algorithm_cn.md
  • docs/开发笔记/ 中 6 个有价值文件 → docs/requirements/
    • 财务页面需求.mdDWS 数据库处理需求.md指数运营场景矩阵.txt
    • 关系指数PRD.txtDWS财务口径补充.mdDWS口径与规则补充.md

文件删除

  • docs/index/ 目录(已空)
  • docs/开发笔记/ 整个目录,含:
    • Note/ 全部 6 个文件(过期笔记)
    • 记录.md(过期)
    • DWS/cfg_index_parameters.csv(旧 INTIMACY 参数,已被数据库 seed 替代)
    • DWS/记录1.md302KB AI 对话记录,无保留价值)

引用更新

  • docs/README.md — 移除 index/开发笔记/ 行,requirements/ 描述更新,database/DWS/ 描述补充指数算法文档
  • .kiro/steering/structure.md — docs/ 目录树替换为当前实际结构
  • scripts/audit/doc_alignment_analyzer.py — 移除 开发笔记/ 扫描逻辑(源 #3更新文档字符串
  • tests/unit/test_audit_doc_alignment.pytest_finds_dev_notestest_finds_docs_subdir_requirements

回滚

  • git revert 即可恢复
  • docs/requirements/ 中的文件可手动移回 docs/开发笔记/

验证

  1. 确认旧目录不存在:docs/index/docs/开发笔记/
  2. 确认 docs/database/DWS/index_algorithm_cn.md 存在
  3. 确认 docs/requirements/ 下有 6 个文件
  4. pytest tests/unit/test_audit_doc_alignment.py 通过
  5. 全文搜索 docs/index/docs/开发笔记 确认活跃文件中无残留引用specs/审计记录除外)