docs: 增加交付文档入口 (#11)
+5
-2
@@ -14,7 +14,7 @@ DevHarness 是一个以 Gitea 工单管理开发任务、以 Wiki 管理长期
|
||||
6. [故障排查](Troubleshooting):遇到错误时按什么顺序检查。
|
||||
7. [开发工作流](Development-Workflow.-):完整建单、实施、验收和归档流程。
|
||||
|
||||
从模板创建新项目时先阅读[新项目文档初始化](New-Project-Documentation-Setup.-)。
|
||||
从模板创建新项目时先阅读[新项目文档初始化](New-Project-Documentation-Setup.-)。需要为客户或其他岗位准备说明时,阅读[交付文档指南](Delivery-Documentation-Guide.-),再按需使用[岗位文档模板](Audience-Document-Template.-)。
|
||||
|
||||
## 五分钟开始
|
||||
|
||||
@@ -41,6 +41,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` | 成功与失败测试 |
|
||||
@@ -53,7 +54,7 @@ python dev_scripts/sync_wiki_docs.py --check
|
||||
| 信息 | 事实来源 |
|
||||
|---|---|
|
||||
| 任务状态、讨论、阻塞、验收过程 | Gitea 工单 |
|
||||
| 架构、业务规则、开发规范、操作手册、任务归档 | Gitea Wiki |
|
||||
| 架构、业务规则、开发规范、操作手册、交付文档、任务归档 | Gitea Wiki |
|
||||
| 源码和与特定代码版本强绑定的文档 | Git 仓库 |
|
||||
| 离线浏览副本 | Git 仓库中的 `docs/` Wiki 镜像 |
|
||||
|
||||
@@ -63,6 +64,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.-)
|
||||
|
||||
## 同步原则
|
||||
|
||||
Reference in New Issue
Block a user