docs: 建立最小交付文档体系 (#11)

This commit is contained in:
QiuSW
2026-08-10 14:25:34 +08:00
parent 4e9f2e1380
commit 3474870499
8 changed files with 285 additions and 13 deletions
+7 -4
View File
@@ -2,8 +2,8 @@
generated: true (请先修改 Gitea Wiki,禁止直接编辑本文件)
wiki_page: Home
wiki_url: http://ilaer.eicp.net:8418/opc/dev_harness/wiki/Home
wiki_revision: f1baf5947fe4e8f08cfc3ccc129946964fbbc3e5
synchronized_at: 2026-08-08T01:16:46Z
wiki_revision: d7c0df9a900296850ca32296211504c5274c2b26
synchronized_at: 2026-08-10T06:23:21Z
<!-- gitea-wiki-mirror:end -->
# DevHarness 文档中心
@@ -22,7 +22,7 @@ DevHarness 是一个以 Gitea 工单管理开发任务、以 Wiki 管理长期
6. [故障排查](Troubleshooting):遇到错误时按什么顺序检查。
7. [开发工作流](Development-Workflow.-):完整建单、实施、验收和归档流程。
从模板创建新项目时先阅读[新项目文档初始化](New-Project-Documentation-Setup.-)。
从模板创建新项目时先阅读[新项目文档初始化](New-Project-Documentation-Setup.-)。需要为客户或其他岗位准备说明时,阅读[交付文档指南](Delivery-Documentation-Guide.-),再按需使用[岗位文档模板](Audience-Document-Template.-)。
## 五分钟开始
@@ -49,6 +49,7 @@ python dev_scripts/sync_wiki_docs.py --check
| 想做什么 | 先读哪里 | 主要验证 |
|---|---|---|
| 修改文档 | 对应 Wiki 页面、Common-Changes | Wiki 同步检查 |
| 准备交付文档 | Delivery-Documentation-Guide、Audience-Document-Template | 目标岗位验证和 Wiki 同步检查 |
| 调整工单字段 | `.gitea/issue_template/`、Development-Workflow | Harness 严格检查 |
| 修改同步行为 | `dev_scripts/wiki_docs.py`、Architecture-and-Code-Map | 单元测试和真实 Wiki 检查 |
| 增加结构检查 | `dev_scripts/check_harness.py` | 成功与失败测试 |
@@ -61,7 +62,7 @@ python dev_scripts/sync_wiki_docs.py --check
| 信息 | 事实来源 |
|---|---|
| 任务状态、讨论、阻塞、验收过程 | Gitea 工单 |
| 架构、业务规则、开发规范、操作手册、任务归档 | Gitea Wiki |
| 架构、业务规则、开发规范、操作手册、交付文档、任务归档 | Gitea Wiki |
| 源码和与特定代码版本强绑定的文档 | Git 仓库 |
| 离线浏览副本 | Git 仓库中的 `docs/` Wiki 镜像 |
@@ -71,6 +72,8 @@ python dev_scripts/sync_wiki_docs.py --check
- [Gitea 工单](http://ilaer.eicp.net:8418/opc/dev_harness/issues)
- [代码仓库](http://ilaer.eicp.net:8418/opc/dev_harness)
- [交付文档指南](Delivery-Documentation-Guide.-)
- [岗位文档模板](Audience-Document-Template.-)
- [任务归档模板](Task-Archive-Template.-)
## 同步原则