迁移 Admin 与 Client 长期文档为 Wiki 镜像 #314

Open
opened 2026-08-26 16:26:21 +08:00 by ila · 1 comment
Owner

基本信息

  • 类型:需求
  • 父级大工单:#310
  • 所属 MVP / 版本:#311
  • 阶段:阶段 3:详细长期文档迁移
  • 原始需求来源:用户在 2026-08-26 要求参考更新后的 D:\OPC\dev_harness 更新本项目文档和工作流
  • 前置工单:#313
  • 是否允许并行:否。会集中修改详细 docs 镜像和映射,避免并发覆盖。
  • 状态:待验收

要解决什么

docs/admin 与 docs/client 约 20 份长期文档仍是手工 Git 主源,与目标 Wiki-first 流程不一致。

做什么 / 不做什么

  • 做:为每份现有详细文档建立唯一 Wiki 页面、在线回读并加入显式映射,然后导出带来源头的本地镜像;保留原正文和路径。
  • 不做:不删除、重命名或压缩业务文档;不改产品规则;不处理 docs/task 历史快照。

怎么做

逐页按当前 Git 正文初始化 Wiki,保持 Client API 契约唯一事实来源和所有安全红线;导出后内容差异只能是镜像头、链接适配和经确认的事实源说明。

预计修改:wiki-docs.json、docs/admin/*.md、docs/client/*.md、docs/README.md

设计证据:非 UI 工作;以 DevHarness 目标提交、事实来源迁移顺序和本工单技术方案作为设计证据。
长期文档影响:有,具体页面和镜像见预计修改。

验收标准

  • 全部现有详细长期文档有唯一 Wiki 页面和 revision
  • 本地路径保留且正文业务事实未被模板覆盖
  • Client API 契约仍是跨子项目唯一事实来源
  • docs/task 290 份历史快照未删除或改写
  • sync --check 和严格检查通过

怎么验证

python dev_scripts/harness.py sync --verify;Git 差异核对;Admin/Client 文档链接检查

风险和回退

长文档迁移易产生截断或链接漂移;每页写入后回读并比较正文,任一不一致停止。

## 基本信息 - 类型:需求 - 父级大工单:#310 - 所属 MVP / 版本:#311 - 阶段:阶段 3:详细长期文档迁移 - 原始需求来源:用户在 2026-08-26 要求参考更新后的 `D:\OPC\dev_harness` 更新本项目文档和工作流 - 前置工单:#313 - 是否允许并行:否。会集中修改详细 docs 镜像和映射,避免并发覆盖。 - 状态:待验收 ## 要解决什么 `docs/admin` 与 `docs/client` 约 20 份长期文档仍是手工 Git 主源,与目标 Wiki-first 流程不一致。 ## 做什么 / 不做什么 - 做:为每份现有详细文档建立唯一 Wiki 页面、在线回读并加入显式映射,然后导出带来源头的本地镜像;保留原正文和路径。 - 不做:不删除、重命名或压缩业务文档;不改产品规则;不处理 `docs/task` 历史快照。 ## 怎么做 逐页按当前 Git 正文初始化 Wiki,保持 Client API 契约唯一事实来源和所有安全红线;导出后内容差异只能是镜像头、链接适配和经确认的事实源说明。 预计修改:`wiki-docs.json`、`docs/admin/*.md`、`docs/client/*.md`、`docs/README.md` 设计证据:非 UI 工作;以 DevHarness 目标提交、事实来源迁移顺序和本工单技术方案作为设计证据。 长期文档影响:有,具体页面和镜像见预计修改。 ## 验收标准 - [ ] 全部现有详细长期文档有唯一 Wiki 页面和 revision - [ ] 本地路径保留且正文业务事实未被模板覆盖 - [ ] Client API 契约仍是跨子项目唯一事实来源 - [ ] `docs/task` 290 份历史快照未删除或改写 - [ ] `sync --check` 和严格检查通过 ## 怎么验证 `python dev_scripts/harness.py sync --verify`;Git 差异核对;Admin/Client 文档链接检查 ## 风险和回退 长文档迁移易产生截断或链接漂移;每页写入后回读并比较正文,任一不一致停止。
ila referenced this issue from a commit 2026-08-26 16:58:05 +08:00
Author
Owner

实施结果

  • 20 个详细页面均已在线创建并回读 revision。
  • 迁移提交:e9d0e31
  • 首页导航提交:a39d538
  • 本地归档提交:ac1e0b3
  • 验证:当前全部 32 个 Wiki 映射执行 sync --check 通过。
  • 历史 docs/task 未删除、未重命名、未批量重写。

状态:待验收。

## 实施结果 - 20 个详细页面均已在线创建并回读 revision。 - 迁移提交:`e9d0e31` - 首页导航提交:`a39d538` - 本地归档提交:`ac1e0b3` - 验证:当前全部 32 个 Wiki 映射执行 `sync --check` 通过。 - 历史 `docs/task` 未删除、未重命名、未批量重写。 状态:待验收。
Sign in to join this conversation.
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: OPC/cmautobuy#314