文件
hyb-oa/issues/2026-05-09_15-50-55-doc-governance-baseline.csv

5.4 KiB

1IDTitleDescriptionAcceptanceTest_MethodToolsDev_StatusReview1_StatusRegression_StatusFilesDependenciesNotes
2A1文档治理执行合同与盘点建立本轮文档治理执行合同,盘点当前 docs 目录中的当前事实源、历史快照、过时口径和审计证据。1) 新 Issue CSV 校验通过;2) 文档治理范围限定在 docs 与本轮 issues;3) 明确不删除历史证据、不批量回改历史 Issue CSV。命令:python3 /home/shunli/.codex/skills/plan/scripts/validate_issues_csv.py issues/2026-05-09_15-50-55-doc-governance-baseline.csv;人工步骤:确认本轮只治理文档命名、索引、状态头和引用。python3DONEDONEDONEissues/2026-05-09_15-50-55-doc-governance-baseline.csv[]不改业务代码、不部署。
3A2主需求文档中文命名与旧路径跳转将当前 PRD 主事实源改为中文文件名,并保留英文旧路径作为跳转说明,方便人工审查且不完全断开旧链接。1) 新主文档为 docs/海音达OA-MVP需求规格说明书.md;2) docs/requirements-specification.md 保留为跳转索引;3) 当前文档引用优先指向中文主文档。人工步骤:打开 docs/海音达OA-MVP需求规格说明书.md 可看到完整 PRD;打开 docs/requirements-specification.md 可看到迁移说明和中文链接。manualDONEDONEDONEdocs/requirements-specification.md|docs/海音达OA-MVP需求规格说明书.md["A1"]旧路径只保留兼容跳转,不再作为主编辑入口。
4A3新增中文文档索引与阅读顺序新增 docs/文档索引.md,按当前事实源、操作手册、实现状态与证据、历史快照、已废弃/过时分组。1) 文档索引能指导老板、开发、测试快速找到当前有效文档;2) 每类文档说明用途和误读风险;3) 明确当前 PRD、产品口径、功能矩阵和 Issue CSV 的职责。人工步骤:阅读 docs/文档索引.md,确认无需翻目录即可理解哪些文档当前有效、哪些只作追溯。manualDONEDONEDONEdocs/文档索引.md["A1","A2"]索引是人工审查入口,不替代 Issue CSV 执行合同。
5A4历史过时文档状态头治理为历史 Phase、一次性方案、试运行报告和状态矩阵加醒目状态头,避免被误读为当前执行计划。1) implementation_plan、tech_stack_report、feature-matrix、todo-reconciliation、manual-trialrun-report、invoice-pool-refactor-plan、integration-boundaries 均有状态说明;2) 状态头说明当前用途和不得误读的边界;3) 不删除历史内容。人工步骤:逐个打开相关文档前 20 行,确认能看到状态说明;命令:rg -n "文档状态|当前用途|不得误读" docs。manual|ripgrepDONEDONEDONEdocs/implementation_plan.md|docs/tech_stack_report.md|docs/feature-matrix.md|docs/todo-reconciliation.md|docs/trialrun/manual-trialrun-report.md|docs/invoice-pool-refactor-plan.md|docs/integration-boundaries.md["A3"]历史文档保留审计价值,治理方式为标记和索引,不做删除。
6A5修正飞书钉钉企微旧口径修正文档中会误导当前路线的飞书、钉钉、企业微信旧口径,固定首批只保留企业微信基础设施,飞书废弃。1) implementation_plan 不再把企微/钉钉通知列为当前待推进;2) integration-boundaries 明确飞书/钉钉真实适配器为历史 backlog,不进入首批;3) manual-trialrun-report 中旧 force_off 状态标为当时快照。命令:rg -n "飞书|钉钉|force_off|Phase 1|当前执行计划" docs;人工判断命中内容不再与当前 PRD 冲突。ripgrep|manualDONEDONEDONEdocs/implementation_plan.md|docs/integration-boundaries.md|docs/trialrun/manual-trialrun-report.md|docs/feature-matrix.md["A4"]不改运行时配置,仅修正文档事实源口径。
7A6引用检查与链接修复修复当前文档之间对需求规格、实施计划、功能矩阵和试运行报告的引用,避免人工审查打开过时入口。1) 当前 docs 中主需求引用优先指向中文 PRD;2) requirements-specification.md 旧路径仅作为跳转;3) 不批量修改历史 Issue CSV;4) 链接相对路径可读。命令:rg -n "requirements-specification\\.md|海音达OA-MVP需求规格说明书\\.md|文档索引\\.md" docs issues/2026-05-09_15-39-29-mvp-requirements-baseline.csv issues/2026-05-09_15-50-55-doc-governance-baseline.csv;人工检查当前引用合理。ripgrep|manualDONEDONEDONEdocs|issues/2026-05-09_15-39-29-mvp-requirements-baseline.csv|issues/2026-05-09_15-50-55-doc-governance-baseline.csv["A2","A3","A4","A5"]历史 Issue CSV 保持不可变,必要兼容由旧路径跳转承担。
8A7文档治理验证与提交完成文档治理后执行 CSV 校验、diff 检查和关键词复核,回填状态并提交。1) 新 Issue CSV 校验通过;2) git diff --check 通过;3) 工作区只包含 docs 与本轮 issues 变更;4) commit message 使用中文并引用 A1-A7。命令:python3 /home/shunli/.codex/skills/plan/scripts/validate_issues_csv.py issues/2026-05-09_15-50-55-doc-governance-baseline.csv && git diff --check && git status --short;人工步骤:确认 docs/文档索引.md 是人工审查入口。python3|git|manualDONEDONEDONEdocs|issues/2026-05-09_15-50-55-doc-governance-baseline.csv["A1","A2","A3","A4","A5","A6"]本轮不部署;完成后提交并说明未部署。