From 191c8f4a601e90e5bfbbfff3d3404c8b824afc40 Mon Sep 17 00:00:00 2001 From: ila <2+ila@noreply.git.ilapage.cn> Date: Mon, 24 Aug 2026 16:20:11 +0800 Subject: [PATCH] docs(#76): simplify documentation responsibilities --- Home.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/Home.md b/Home.md index 47e9a0d..d440689 100644 --- a/Home.md +++ b/Home.md @@ -1,6 +1,6 @@ # GoAuto 文档中心 -GoAuto 使用 Gitea 工单记录任务过程，使用 Gitea Wiki 维护长期开发文档，使用 Git 保存源码、版本绑定资料和 Wiki 的本地镜像。 +GoAuto 使用 Gitea 工单记录单次任务的完整过程，使用 Gitea Wiki 维护长期事实，使用 Git 保存源码、迁移、测试、版本绑定资料和 Wiki 的本地镜像。标准任务不再重复建立 Wiki 任务归档。 ## 建议阅读顺序 @@ -24,39 +24,41 @@ GoAuto 使用 Gitea 工单记录任务过程，使用 Gitea Wiki 维护长期开 | 信息 | 唯一事实来源 | |---|---| -| 任务状态、讨论、阻塞、需求变化和验收过程 | Gitea 单元工单 | -| 长期产品需求、架构、业务规则、开发规范、操作说明和任务归档 | Gitea Wiki | +| 单次任务需求、讨论、方案变化、实现、测试、提交、阻塞和验收 | Gitea 单元工单 | +| 长期产品需求、架构、业务规则、开发规范、契约和操作说明 | Gitea Wiki | | 跨服务端与 Android 的共享接口 | Wiki 的 Android-Agent-API-Contract 页面 | | 源码、迁移、版本绑定分析、本地 HTML 原型和规则 JSON | Git 仓库 | | 核心长期文档的离线副本 | Git 仓库 `docs/` 中的 Wiki 只读镜像 | | 外部交互原型 | QuantUX 链接、App ID 和对应工单记录 | -本地映射 Markdown 不是编辑入口。长期文档固定顺序是：修改 Wiki → 读取确认 → 导出核心 `docs/` → 检查一致性 → 提交镜像。任务归档默认只保存在 Wiki，只有用户明确要求时才导出到 `docs/task/`。 +本地映射 Markdown 不是编辑入口。只有长期事实变化时才执行：修改 Wiki → 读取确认 → 导出核心 `docs/` → 检查一致性 → 提交镜像。无长期文档影响的任务完全跳过 Wiki 同步。既有任务归档和 `docs/task/` 只作历史兼容；仅在用户明确要求专项快照时创建或导出。 + +## 权威源与事实边界 + +文档或界面与实现冲突时，依次以可执行代码与自动化测试、已批准的共享契约和决策、当前长期 Wiki、旧设计稿、注释/UI 文案/历史示例为准。 + +“当前实现”必须能在指定提交上复核；“目标契约”表示尚待实施或验收的目标，不能用来宣称现有能力。基线或差距审计需记录 commit、核验日期、证据路径、范围、不在范围和证据不能证明的内容。 ## 五分钟检查 ```powershell git status --short --branch -python dev_scripts/harness.py sync --check +python dev_scripts/harness.py check --strict 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)。 +预期结果是工作区范围明确、治理结构和 Wiki 工具单元测试通过，并且受影响的交付单元验证通过；只有本次修改了长期 Wiki 时才另跑 `sync --check`。具体环境、分组件命令和真机范围见[本地开发与验证](https://git.ilapage.cn/OPC/goauto/wiki/Local-Development-and-Verification)。 ## 同步与归档 ```powershell -# 从 Wiki 单向导出核心文档 +# 仅当长期事实变化时：单向导出并检查核心文档 python dev_scripts/harness.py sync - -# 只检查一致性 python dev_scripts/harness.py sync --check -# 创建 Wiki 任务归档草稿，不自动导出本地 +# 仅当用户明确要求专项历史快照时 python dev_scripts/harness.py archive 43 "升级 DevHarness 文档基线" - -# 仅在用户明确要求时导出任务归档 python dev_scripts/harness.py export ```