docs: prepare Wiki-first migration (#43)

This commit is contained in:
QiuSW
2026-08-17 11:27:09 +08:00
parent cde2a84211
commit a4ac398ca0
17 changed files with 1457 additions and 103 deletions
+59 -15
View File
@@ -1,19 +1,63 @@
# Harness Coding 文档中心
# GoAuto 文档中心
本文档集面向项目负责人、开发 Agent 和接手维护的程序员。建议按编号顺序阅读。
GoAuto 使用 Gitea 工单记录任务过程,使用 Gitea Wiki 维护长期开发文档,使用 Git 保存源码、版本绑定资料和 Wiki 的本地镜像。
| 文档 | 回答的问题 |
## 建议阅读顺序
1. [项目档案](https://git.ilapage.cn/OPC/goauto/wiki/Project-Profile):项目目标、建设基线、交付单元和当前阶段。
2. [产品需求总览](https://git.ilapage.cn/OPC/goauto/wiki/Product-Requirements-Overview):长期需求状态、工单、原型和当前采集闭环。
3. [架构与代码地图](https://git.ilapage.cn/OPC/goauto/wiki/Architecture-and-Code-Map):请求怎样跨服务端、Web 和 Android 流动。
4. [业务规则与术语](https://git.ilapage.cn/OPC/goauto/wiki/Business-Rules-and-Glossary):重要状态和不能破坏的规则。
5. [本地开发与验证](https://git.ilapage.cn/OPC/goauto/wiki/Local-Development-and-Verification):怎样启动、测试和真机验证。
6. [常见修改指南](https://git.ilapage.cn/OPC/goauto/wiki/Common-Changes):常见修改入口、风险和停止条件。
7. [故障排查](https://git.ilapage.cn/OPC/goauto/wiki/Troubleshooting):出现错误时按什么顺序检查。
8. [开发工作流](https://git.ilapage.cn/OPC/goauto/wiki/Development-Workflow):完整建单、设计门禁、实施和验收流程。
专题资料:
- [Android Agent API 契约](https://git.ilapage.cn/OPC/goauto/wiki/Android-Agent-API-Contract)
- [工单与依赖索引](https://git.ilapage.cn/OPC/goauto/wiki/Delivery-Issues)
- [一加真机验收](https://git.ilapage.cn/OPC/goauto/wiki/OnePlus-Real-Device-Acceptance)
- [PDD 商品详情规则迁移分析](https://git.ilapage.cn/OPC/goauto/wiki/PDD-Detail-Rule-Migration-Analysis)
## 事实来源
| 信息 | 唯一事实来源 |
|---|---|
| `00-project-profile.md` | 项目是什么、包含哪些交付单元 |
| `01-workflow.md` | 如何从需求、工单走到验收 |
| `02-architecture-and-code-map.md` | 请求如何跨服务端、Web 和 Android 流动 |
| `03-business-rules-and-glossary.md` | 哪些业务与安全规则不能破坏 |
| `04-local-development-and-verification.md` | 如何运行与验证 |
| `05-common-changes.md` | 常见修改从哪里开始 |
| `06-troubleshooting.md` | 失败时按什么顺序排查 |
| `07-mvp-requirements.md` | 第一阶段必须交付什么 |
| `08-agent-api-contract.md` | Android 与服务端的共享接口 |
| `09-delivery-issues.md` | 一期 Epic、MVP、Task 及依赖索引 |
| `10-real-device-acceptance.md` | 一加/ColorOS 真机闭环验收证据与待测项 |
| 任务状态、讨论、阻塞、需求变化和验收过程 | Gitea 单元工单 |
| 长期产品需求、架构、业务规则、开发规范、操作说明和任务归档 | Gitea Wiki |
| 跨服务端与 Android 的共享接口 | Wiki 的 Android-Agent-API-Contract 页面 |
| 源码、迁移、版本绑定分析、本地 HTML 原型和规则 JSON | Git 仓库 |
| 核心长期文档的离线副本 | Git 仓库 `docs/` 中的 Wiki 只读镜像 |
| 外部交互原型 | QuantUX 链接、App ID 和对应工单记录 |
当前 `docs/` 由 Git 直接维护。后续启用 Gitea Wiki 镜像时,必须通过独立工单迁移,不能形成两个互相冲突的事实来源。
本地映射 Markdown 不是编辑入口。长期文档固定顺序是:修改 Wiki → 读取确认 → 导出核心 `docs/` → 检查一致性 → 提交镜像。任务归档默认只保存在 Wiki,只有用户明确要求时才导出到 `docs/task/`。
## 五分钟检查
```powershell
git status --short --branch
python dev_scripts/sync_wiki_docs.py --check
python -m unittest discover -s tests -v
.\scripts\verify.ps1 -Component all
```
预期结果是工作区范围明确、所有 Wiki 映射一致、Wiki 工具单元测试通过,并且受影响的三端验证通过。具体环境、分组件命令和真机范围见[本地开发与验证](https://git.ilapage.cn/OPC/goauto/wiki/Local-Development-and-Verification)。
## 同步与归档
```powershell
# 从 Wiki 单向导出核心文档
python dev_scripts/sync_wiki_docs.py
# 只检查一致性
python dev_scripts/sync_wiki_docs.py --check
# 创建 Wiki 任务归档草稿,不自动导出本地
python dev_scripts/new_task_archive.py 43 "升级 DevHarness 文档基线"
# 仅在用户明确要求时导出任务归档
python dev_scripts/export_task_archives.py
```
凭据只通过 `GITEA_TOKEN` 环境变量提供,不写入配置、日志、工单、Wiki 或文档。