docs: 精简任务事实来源与工程基线 (#25)
@@ -33,7 +33,7 @@ DevHarness 不是业务应用,而是一套开发工作流模板。它约束 Ag
|
||||
| Wiki 页面映射 | `wiki-docs.json` | `mappings` | 页面名、本地路径 | `harness.py sync --check` | 中 |
|
||||
| Wiki API 和镜像生成 | `dev_scripts/wiki_docs.py` | `WikiClient`、`sync_all` | 配置、页面、镜像元数据 | `tests/test_wiki_docs.py` | 中 |
|
||||
| 同步与校验 | `dev_scripts/harness.py` | `run_sync()` | `sync [--check] [--verify]` | 线上 Wiki 对照检查 | 低 |
|
||||
| 任务归档 | `dev_scripts/harness.py` | `run_archive()` | `archive <编号> <短标题>` | 单元测试和正式归档 | 中 |
|
||||
| 可选任务快照 | `dev_scripts/harness.py` | `run_archive()` | `archive <编号> <短标题>` | 单元测试和显式专项归档 | 中 |
|
||||
| Harness 结构检查 | `dev_scripts/harness.py` | `run_check()` | 必需文件、镜像、归档检查 | `check --strict` | 中 |
|
||||
| 本地文档镜像 | `docs/` | `docs/README.md` | 生成元数据和 Wiki 正文 | 同步检查 | 低 |
|
||||
| 自动化测试 | `tests/` | `test_wiki_docs.py` | 映射、同步和安全边界 | `unittest discover` | 低 |
|
||||
@@ -51,16 +51,17 @@ wiki-docs.json
|
||||
→ --check 对照正文和 revision
|
||||
```
|
||||
|
||||
### 任务归档
|
||||
### 可选任务快照
|
||||
|
||||
```text
|
||||
读取 Wiki 归档模板
|
||||
→ 创建 Task-<编号>-<标题> 页面
|
||||
→ 追加显式页面映射
|
||||
→ 导出 docs/task 镜像
|
||||
→ 提交镜像并回写工单
|
||||
用户或项目专用规则明确要求专项快照
|
||||
→ 读取 Wiki 归档模板
|
||||
→ 创建 Task-<编号>-<标题> 页面并链接原工单
|
||||
→ 按需 export 到 docs/task
|
||||
```
|
||||
|
||||
默认任务流程不调用这条路径。单次任务的需求、实现、测试、提交和验收保存在 Gitea 工单;既有归档和导出功能仅用于历史兼容或明确的专项快照。
|
||||
|
||||
## 修改影响判断
|
||||
|
||||
| 修改内容 | 通常还要检查 |
|
||||
@@ -73,7 +74,7 @@ wiki-docs.json
|
||||
|
||||
## 不可破坏的边界
|
||||
|
||||
- 工单管理过程,Wiki 管理长期文档,Git 管理代码和镜像。
|
||||
- 工单管理单次任务,Wiki 管理长期文档,Git 管理代码和版本绑定资料;可选任务快照不是默认事实来源。
|
||||
- `docs/` 不是长期文档编辑入口。
|
||||
- 同步只允许写入 `docs/` 下的 Markdown。
|
||||
- 页面删除、重命名和本地脏镜像不能被静默处理。
|
||||
|
||||
Reference in New Issue
Block a user