如何使用工程文档
- 文档状态
- approved
- 文档 Owner
- DOC
- 事实源
- canonical-docs
- 更新
- 2026/10/14
按角色读取
| 角色 | 必读 | 产出 |
|---|---|---|
| 产品 / 领域 owner | Requirement、AC、非目标、开放决策 | 批准边界与优先级 |
| 设计 | 用户流程、页面状态、错误恢复、无障碍 | UI / FLOW 资产与评审证据 |
| 开发 | 架构、API / Protocol / Schema、Code Map、WP | MR、迁移、契约实现 |
| 测试 | AC、状态机、错误、测试规格、Fixture | TEST 与 FIX 资产、失败证据 |
| 发布 / 运维 | 兼容、迁移、SLO、Runbook、回滚 | release evidence 与现场验证 |
规范性关键词
MUST / MUST NOT 是门禁要求,SHOULD 允许有记录的偏差,MAY 是可选行为。中文正文可使用“必须 / 不得 / 应 / 可以”,但同一条合同不得混用导致强度不清。
事实与状态
- 文档拥有范围、设计、验收和关系;Git owning repo 拥有实现与测试;Plane 拥有工作执行状态。
- Asset ID 是跨系统语义身份;Git commit、symbol、test name、Plane UUID 是系统内定位。
draft表示合同仍可变;approved表示 owner 已批准。两者都不等于已实现或已上线。- 运行事实必须读取 owning system。Issue 进度读取 Plane 原生 Issue 状态;执行、重试和停止读取官方 Symphony。Plane 委托开关不证明服务在线。
修改顺序
先修改规范性合同与资产关系,再修改实现;接口或 Schema 改变时同时提交兼容说明和契约测试;工作完成后登记固定 commit 与证据,不把某次环境状态写进长期规范。