docs: add product requirements overview (#18)
This commit is contained in:
+12
-8
@@ -2,8 +2,8 @@
|
||||
generated: true (请先修改 Gitea Wiki,禁止直接编辑本文件)
|
||||
wiki_page: Home
|
||||
wiki_url: https://git.ilapage.cn/OPC/dev_harness/wiki/Home
|
||||
wiki_revision: c1c1f27f33bd8d413787921e6a04b9ea32d80286
|
||||
synchronized_at: 2026-08-16T12:37:05Z
|
||||
wiki_revision: a71a7309c9298b63946d5b784322659171c2e984
|
||||
synchronized_at: 2026-08-17T01:57:45Z
|
||||
<!-- gitea-wiki-mirror:end -->
|
||||
|
||||
# DevHarness 文档中心
|
||||
@@ -15,12 +15,13 @@ DevHarness 是一个以 Gitea 工单管理开发任务、以 Wiki 管理长期
|
||||
建议按以下顺序,用 10~20 分钟建立整体认识:
|
||||
|
||||
1. [项目档案](Project-Profile.-):项目目标、环境、命令和目录边界。
|
||||
2. [架构与代码地图](Architecture-and-Code-Map.-):功能从哪里开始读、测试在哪里。
|
||||
3. [业务规则与术语](Business-Rules-and-Glossary.-):重要名词、状态和不能破坏的规则。
|
||||
4. [本地开发与验证](Local-Development-and-Verification.-):怎样运行、测试和排错。
|
||||
5. [常见修改指南](Common-Changes.-):简单修改的步骤和停止条件。
|
||||
6. [故障排查](Troubleshooting):遇到错误时按什么顺序检查。
|
||||
7. [开发工作流](Development-Workflow.-):完整建单、实施、验收和归档流程。
|
||||
2. [产品需求总览](Product-Requirements-Overview.-):长期需求、状态、原型和验收入口。
|
||||
3. [架构与代码地图](Architecture-and-Code-Map.-):功能从哪里开始读、测试在哪里。
|
||||
4. [业务规则与术语](Business-Rules-and-Glossary.-):重要名词、状态和不能破坏的规则。
|
||||
5. [本地开发与验证](Local-Development-and-Verification.-):怎样运行、测试和排错。
|
||||
6. [常见修改指南](Common-Changes.-):简单修改的步骤和停止条件。
|
||||
7. [故障排查](Troubleshooting):遇到错误时按什么顺序检查。
|
||||
8. [开发工作流](Development-Workflow.-):完整建单、实施、验收和归档流程。
|
||||
|
||||
从模板创建新项目时先阅读[新项目文档初始化](New-Project-Documentation-Setup.-);向已有项目增量接入本流程时阅读[已有项目接入 DevHarness 指南](Existing-Project-Adoption-Guide.-)。需要为客户或其他岗位准备说明时,阅读[交付文档指南](Delivery-Documentation-Guide.-),再按需使用[岗位文档模板](Audience-Document-Template.-)。
|
||||
|
||||
@@ -49,6 +50,7 @@ python dev_scripts/sync_wiki_docs.py --check
|
||||
| 想做什么 | 先读哪里 | 主要验证 |
|
||||
|---|---|---|
|
||||
| 修改文档 | 对应 Wiki 页面、Common-Changes | Wiki 同步检查 |
|
||||
| 查看或更新产品需求 | Product-Requirements-Overview、对应主题 Wiki 和工单 | 状态、链接和事实来源核对 |
|
||||
| 接入已有项目 | Existing-Project-Adoption-Guide | 只读盘点、差异确认和分阶段验证 |
|
||||
| 准备交付文档 | Delivery-Documentation-Guide、Audience-Document-Template | 目标岗位验证和 Wiki 同步检查 |
|
||||
| 调整工单字段 | `.gitea/issue_template/`、Development-Workflow | Harness 严格检查 |
|
||||
@@ -63,6 +65,7 @@ python dev_scripts/sync_wiki_docs.py --check
|
||||
| 信息 | 事实来源 |
|
||||
|---|---|
|
||||
| 任务状态、讨论、阻塞、验收过程 | Gitea 工单 |
|
||||
| 长期产品需求的统一导航和状态 | Gitea Wiki 的 Product-Requirements-Overview |
|
||||
| 架构、业务规则、开发规范、操作手册、交付文档、任务归档 | Gitea Wiki |
|
||||
| 源码和与特定代码版本强绑定的文档 | Git 仓库 |
|
||||
| 核心长期文档的离线浏览副本 | Git 仓库中的 `docs/` Wiki 镜像 |
|
||||
@@ -73,6 +76,7 @@ python dev_scripts/sync_wiki_docs.py --check
|
||||
## 项目入口
|
||||
|
||||
- [Gitea 工单](https://git.ilapage.cn/OPC/dev_harness/issues)
|
||||
- [产品需求总览](Product-Requirements-Overview.-)
|
||||
- [代码仓库](https://git.ilapage.cn/OPC/dev_harness)
|
||||
- [已有项目接入 DevHarness 指南](Existing-Project-Adoption-Guide.-)
|
||||
- [交付文档指南](Delivery-Documentation-Guide.-)
|
||||
|
||||
Reference in New Issue
Block a user