docs: 精简任务事实来源与工程基线 (#25)
+5
-5
@@ -58,10 +58,10 @@ python dev_scripts/harness.py sync --check
|
||||
|---|---|
|
||||
| 任务状态、讨论、阻塞、验收过程 | Gitea 工单 |
|
||||
| 长期产品需求的统一导航和状态 | Gitea Wiki 的 Product-Requirements-Overview |
|
||||
| 架构、业务规则、开发规范、操作手册、交付文档、任务归档 | Gitea Wiki |
|
||||
| 架构、业务规则、开发规范、操作手册和交付文档 | Gitea Wiki |
|
||||
| 源码和与特定代码版本强绑定的文档 | Git 仓库 |
|
||||
| 核心长期文档的离线浏览副本 | Git 仓库中的 `docs/` Wiki 镜像 |
|
||||
| 完整任务归档 | Gitea Wiki;`docs/task/` 仅是人工按需导出的快照 |
|
||||
| 单次任务需求、实现、测试和验收 | Gitea 工单;专项 Wiki 快照仅在人工明确要求时创建 |
|
||||
|
||||
本地 `docs/` 不是编辑入口。长期文档必须先修改 Wiki,读取确认后再导出镜像。
|
||||
|
||||
@@ -73,7 +73,7 @@ python dev_scripts/harness.py sync --check
|
||||
- [已有项目接入 DevHarness 指南](Existing-Project-Adoption-Guide.-)
|
||||
- [交付文档指南](Delivery-Documentation-Guide.-)
|
||||
- [岗位文档模板](Audience-Document-Template.-)
|
||||
- [任务归档模板](Task-Archive-Template.-)
|
||||
- [可选任务归档模板(兼容)](Task-Archive-Template.-)
|
||||
|
||||
## 同步原则
|
||||
|
||||
@@ -82,9 +82,9 @@ python dev_scripts/harness.py sync --check
|
||||
```
|
||||
|
||||
- 核心页面和本地路径通过仓库中的 `wiki-docs.json` 显式映射;普通同步不处理任务归档。
|
||||
- 任务归档默认只保存在 Wiki,只有用户明确提出时才增量或全量导出到 `docs/task/`。
|
||||
- 默认不创建任务归档;只有用户明确要求专项快照或项目专用规则要求时,才创建 Wiki 归档并按需导出到 `docs/task/`。
|
||||
- 镜像头记录来源页面、Wiki revision 和同步时间。
|
||||
- 已映射镜像存在未提交修改时同步必须停止。
|
||||
- 页面删除、重命名和映射变更必须人工确认。
|
||||
- 核心 Wiki 或必要同步失败时,相关任务不能标记为完成;未请求任务归档导出不阻止任务完成。
|
||||
- 长期事实发生变化而核心 Wiki 或必要同步失败时,相关任务不能标记为完成;没有长期文档变化时不运行 Wiki 同步,未请求可选归档不阻止任务完成。
|
||||
- 凭据、个人数据和生产数据不得进入 Wiki 或镜像。
|
||||
|
||||
Reference in New Issue
Block a user