文档治理

当前权威层级

当多个文件表达同一主题时,按以下顺序判断当前事实:

  1. docs/handbook/ 中状态为 canonical 的手册;
  2. docs/specs/ 中的详细实现规格;
  3. docs/research/ 中的研究材料、审计和历史记录;
  4. 根目录发布文件只表达对应的发布状态,不替代研究手册。

一个主题只能有一个当前 canonical 文档。旧文件保留,但不能和 canonical 文档同时被展示为当前定义。

文档状态

状态含义
canonical当前正式版本,作为该主题的单一事实源
draft已开始编写,但尚未成为正式版本
planned已进入规划,但内容尚未建立
legacy历史参考或旧镜像,不作为当前事实

文档状态与研究结论的 A/B/C、数据的 Actual/Projection、Data Gap 的 open/under_review 分开使用,不能混为同一个状态体系。

旧资料迁移

以下 docs/research/ 文件保留为 legacy mirror,当前权威内容以对应的 docs/specs/ 文件为准:

  • PROJECT.md
  • PRODUCT_SPEC.md
  • DATA_MODEL.md
  • DATA_SOURCE_SPEC.md
  • CONTENT_MODEL.md
  • ROUTES_AND_PAGES.md
  • TECH_STACK.md

本阶段不物理删除、不覆盖历史文件;后续如果引用全部迁移完成,再单独评估归档。

发布状态与研究版本分开

  • data/research/version_history.json:记录研究、数据、证据和产品状态变化;当前研究版本由 currentRelease 和记录共同说明。
  • RELEASE_MANIFEST.json:记录产品版本、构建验证和 release-critical 路由;deployed 表示生产发布环境已经建立,具体某次构建是否在线由 release.json 的 artifact identity 和双域名 release canary 验证。
  • data/research/data_gaps.json:Data Gap 的唯一事实源;发布清单不复制缺口状态。
  • src/domain/project/documents.ts:当前能力摘要的唯一事实源;项目首页不要从发布文件推断研究能力。
  • QA_REPORT.md:记录检查范围和验证限制,不因为本地一次构建通过就自动改写历史发布声明。

因此首页分别展示研究版本、产品版本/构建状态和线上环境说明,不把二者合并成一个完成度百分比,也不把本地验证结果冒充某个具体 artifact 已在线;具体构建只有通过双域名 canary 后,才能认定为本次线上发布完成。

相关文档 Related documents