附录 A：常用文档模板（贯穿式业务示例）

找到这一步需要的文档

选择用途，跳到完整示例。每份 Demo 都可以复制使用。

22 份

找到 22 份文档示例

A.1README / 文档索引建立项目入口与阅读路径 A.2AGENTS / 工程规范明确 Agent 的执行规则与硬约束 A.3需求 / Intent / PRD定义目标、范围与验收条件 A.4术语 / 领域模型 / 架构统一语言、职责和模块边界 A.5技术方案 / RFC比较方案与实施代价 A.6D-ID / ADR 决策记录保留决策依据与替代方案 A.7SPEC / 接口契约对齐接口、权限与失败语义 A.8UI / 交互与无障碍约定页面状态和用户操作 A.9安全与威胁模型识别风险与执行边界 A.10实施计划切片把任务拆成可验证的单元 A.11测试策略与用例设计选择测试类型，映射验收条件 A.12数据库变更与迁移方案定义数据变更与恢复方式 A.13Standards / Spec 双轴审查记录发现、修复与复核结果 A.14验证记录 / EVIDENCE归档真实执行证据 A.15Release Manifest 交付清单固定联合交付的版本与制品 A.16Runbook 运维与故障处置写清诊断、恢复与停止入口 A.17复盘与知识回写将教训回写到权威文档 A.18Agent 授权、审计与停止演练验证运行时的可执行边界 A.19需求收集与澄清从问题证据、目标到验收草案 A.20优先级与取舍记录说明排序依据、依赖和暂缓条件 A.21迭代计划与变更记录记录容量、切片安排与重排取舍 A.22版本计划与效果评估关联交付范围、发布窗口与实际效果

示例业务背景：虚构的**“异步报表导出”**功能（涵盖任务受理、后台 Worker 生成、下载与状态恢复）。可落地于单仓多模块架构，亦可拆分为 API、Worker、Web 多个独立服务仓。所有编号、阈值与状态均为演示设定，重点展示信息架构与契约职责。

A.1 README / 文档索引示例

markdown

# 报表中心服务 (Report Service)
用途：用户导出本人有权查看的报表，生成文件后再下载。

阅读入口：
- 开发：AGENTS.md → 工程规范 → 本次 SPEC
- 理解业务：领域模型 → 决策索引
- 验证：测试策略 → 本次测试计划与 EVIDENCE
- 发布和故障：发布记录 → Runbook

当前边界：本示例只设计 CSV 导出；Excel、定时发送暂不包含。
启动和验证命令：链接到仓库真实脚本及配置，不在这里复制第二套。
维护人：项目负责人；入口或能力范围变化时更新。

A.2 AGENTS / 工程规范示例

markdown

# 开发约束
适用：本项目全部模块；子目录额外规则由明确指针说明。

工程约定：
- API 负责认证和请求接入，Worker 负责生成文件。
- 导出任务状态只有任务服务可以修改；页面只展示服务端事实。
- 异步任务明确适用的超时、停止、排空与资源释放路径。
- 本例暂不提供用户取消功能；如需支持，须补充取消状态、竞态及资源清理契约。
- 日志记录关联 ID 与错误分类，不记录令牌或报表内容。

门禁登记：
| 规则与适用范围 | 执行命令与执行者 | 阻断位置 | 结果证据 | 已知盲区 |
| :--- | :--- | :--- | :--- | :--- |
| 类型与格式：受影响模块 | <命令/执行者> | <提交/CI入口> | <日志与报告> | 不能判断权限语义 |
| 模块依赖：项目定义的依赖范围 | <检查器/执行者> | <实际阻断机制> | <报告与版本> | 不能发现复制实现的业务规则 |

人工复核项：
- 当前权限是否在下载时重新检查；
- 测试是否真正观察了重复提交产生的副作用。

*尚未接入执行流程的工具明确标为计划中，不能填写为已强制。*

A.3 需求说明（Intent / PRD）示例

本模板承接 A.19 的需求线索，表达待确认的交付范围；来源和问题证据保留在需求记录中，不重复维护两份事实。

markdown

# 异步报表导出需求说明
状态：草案；负责人：<填写>；关联需求：REQ-EXAMPLE-001（见 A.19）。
问题证据：沿用 A.19；当前假设尚待核实，不代表已完成用户调研。
目标用户：有报表查看权限的登录用户。
交付目标：用户能确认原请求、查看进度，并取得有权访问的 CSV 文件。
范围：提交、原请求查询、生成、下载、失败及到期提示。
非目标：Excel、邮件发送、定时导出、批量共享与用户取消。

验收准则：采用快速上手 AC-01～AC-06，经需求负责人确认后生效。
效果评估：基线、指标口径和观察窗口在 A.19 确认，在 A.22 回写实际结果。
待决策：去重期限、文件保留期限、最大导出规模和数据读取口径。
依赖决定：D-EXAMPLE-001；接口与状态细节见 A.7。

A.4 术语 / 领域模型 / 架构示例

markdown

# 导出领域与责任边界
ExportRequest：用户提交的规范化筛选条件与请求标识。
ExportJob：服务端受理后持久化的任务。
ExportArtifact：生成并发布的文件。
UNKNOWN：客户端尚未确认提交结果；不是服务端任务失败状态。

状态（候选设计，决策被接受后才可用于实现）：
QUEUED → RUNNING → READY → EXPIRED
RUNNING → FAILED
RUNNING → QUEUED：仅由租约过期后的恢复机制触发，并增加执行代际。

权威：
- 身份模块提供经过认证的 tenant_id 和 actor_id。
- 任务模块维护任务状态、请求摘要和当前执行代际。
- 存储适配器保存文件；页面不能自行推导 READY。

不变量：
- 去重保留期内，同一作用域的同键同请求对应同一任务。
- 旧执行代际不能覆盖新代际发布的结果。
- 文件生成成功并不意味着所有用户都具备下载权限（仍须按租户与权限校验）。

A.5 技术方案 / RFC 示例

markdown

# RFC：导出执行方式
状态：候选方案，待决策。
约束：单任务可能超过 HTTP 超时；已有关系数据库；需跨重启恢复。

备选：
A. 同步 HTTP 生成：简单，但长请求与断线恢复成本高。
B. 数据库任务表 + Worker：复用已有存储，需实现租约、重试和代际保护。
C. 外部工作流平台：能力完整，但增加运维与依赖成本。

建议 B：当前规模先复用数据库任务表。
实现前验证：并发认领任务、租约失效，以及拒绝旧 Worker 发布结果的机制。
风险：热点轮询、长任务租约、孤儿文件。
退出条件：达到已约定容量阈值或工作流复杂度后，重新评估 C。

发布影响、恢复方法和验证方式链接到迁移方案与测试计划。

A.6 D-ID / ADR 决策记录示例

markdown

# D-EXAMPLE-001：导出提交去重
状态：Proposed；负责人：产品与服务负责人。
关联：上述 RFC、导出 SPEC。
替代：无；若未来改变保留期限，新建决定并链接本条。

候选决定：
- 作用域 = tenant_id + actor_id；幂等唯一键 = 作用域 + request_id。
- 同键同摘要返回原任务；同键异摘要返回冲突。
- 示例去重期限为受理后 24 小时；文件 READY 后保留 1 小时。
- 文件过期不清除仍在去重期内的请求映射。
- 去重期限外不保证仍能查回；客户端不得自动换键重发。

后果：多保存请求映射；减少断线后重复导出的不确定性。
待确认：容量估算、最大导出规模、数据读取时点或一致性口径，以及用户恢复体验。
交付状态：未实现；未验证；未部署。

A.7 SPEC / 接口契约示例

markdown

# SPEC：导出提交与结果恢复
前置：D-EXAMPLE-001 已被有权负责人接受。
本示例状态：待实现；上述前置条件尚未满足，也尚未交付。

POST /exports
- tenant_id、actor_id 来自服务端认证上下文，不信任客户端自报值。
- 请求含 request_id、筛选条件和 format=CSV。
- 校验权限与参数后，原子建立请求映射和任务。
- 新请求返回任务 ID；同键同摘要返回原任务 ID。
- 同键异摘要返回 409，不创建任务。

GET /export-requests/{request_id}
- 只查当前认证作用域内的原请求，不产生写入。
- 在认证作用域仍获授权且请求映射处于保留期内时查回原任务。
- 文件到期不提前清除仍在去重期内的映射；保留期外不保证仍可查回。
- 未找到、拒绝或暂不可用不自动触发新提交，也不自行换键。

GET /exports/{id}
GET /exports/{id}/download
- 分别检查任务访问权限与当前数据权限。
- READY 才能下载；到期返回明确的过期状态。
- 生成与下载须覆盖 AC-05/06；筛选、格式、数据读取口径及到期计算以已接受决定为准。
- 任务查询与下载均不能绕过已撤销的权限。

结果未知：
保留原 request_id 与原参数，通过只读查询确认实际状态；
长期未查回时给出用户可理解的处理入口，不伪造失败。

A.8 UI / 交互与无障碍示例

markdown

# 导出交互
入口：报表页“导出 CSV”。
状态：可提交、提交中、结果未知、排队、生成中、可下载、失败、已过期。

结果未知：
- 显示“正在确认本次导出是否已受理”；
- 保留原 request_id，暂时阻止重复提交同一意向；
- 查询恢复沿用原请求，不因刷新页面而创建新意向。

失败：显示服务端分类后的原因与适用恢复动作。
过期：显示文件已过期，新建导出需用户明确发起。
可访问性：状态变化有读屏提示，焦点不因轮询跳动；
键盘能完成提交、查询和下载。

视觉验收：桌面与项目支持的窄屏；长报表名、无数据、权限撤销。
后端真实性：布局阶段可以用夹具；真实受理与下载权限另行验证。

A.9 安全与威胁模型示例

markdown

# 导出安全设计
资产：报表内容、任务元数据、身份令牌。
信任边界：浏览器 → API → Worker → 文件存储。

威胁与控制：
- 猜测他人任务 ID：每次读取与下载都验证当前主体权限。
- 客户端篡改 tenant_id：服务端只使用认证上下文。
- 权限撤销后仍下载：下载入口再次授权，文件存储不直接公开。
- 重复提交消耗资源：作用域去重、频率和容量上限。
- 文件生成后任务发布失败：孤儿文件按所属任务和代际清理。

验收：验证跨用户、跨租户、撤权、过期与并发提交的预期响应；
无权限访问应被拒绝，同键同参并发提交应返回原任务。
日志：保留关联 ID、分类和耗时，不保存令牌、筛选敏感值或文件正文。

A.10 实施计划与切片示例

markdown

# 异步导出实施计划
状态：候选计划；关键决定尚未接受，不得据此宣称已开工或完成。
前置：确认 A.6 的决定，完成 A.7 契约与测试计划审查。

S1：受理与查询
- 任务与请求映射、唯一约束、认证作用域、提交及查询 API。
- 验证 AC-01/02 和 AC-04 的任务查询部分。

S2：执行与结果（依赖 S1）
- Worker 认领、租约、执行代际、文件生成与结果发布。
- 验证 AC-05/06：结果正确、失败/到期、重启恢复和旧代际隔离。

S3：用户端闭环（依赖 S1/S2）
- 页面提交、响应丢失恢复、真实状态展示及安全下载。
- 验证 AC-03、AC-04 的下载与界面部分及 AC-05/06 的用户可见结果。

版本验收与发布准备：
- 对完整候选组合执行端到端、权限、容量、迁移及恢复验收。
- 核对运行监控、告警、操作手册与发布准入条件。

每个切片记录负责人、验收入口、证据及剩余问题。
模块可在同一仓库；跨仓时补充契约版本和集成节点。

A.11 测试策略与用例设计示例

验收项	测试设计	依赖与执行安排	本示例状态
相同请求规范化摘要一致	单元／性质：字段顺序变化不改变语义摘要	纯计算，编辑中与提交检查	NOT_RUN
并发重复只建一个任务	集成：并发 20 次同键请求，独立查询任务数为 1	真实数据库，相关改动及完整验证	NOT_RUN
同键异参数拒绝	契约：返回冲突，原任务不被覆盖	真实存储，提交／集成入口	NOT_RUN
提交后响应丢失	故障 E2E：截断受理回复，页面重载并查回原任务	真实 API、Worker、DB、浏览器	NOT_RUN
旧 Worker 不能发布	故障：旧租约过期后新代际认领，旧代际 CAS 被拒	真实存储或独立声明的模拟	NOT_RUN
无权读取或下载	安全契约：跨用户、跨租户及权限撤销后拒绝	真实授权路径	NOT_RUN
生成正确文件	内容验收：筛选、格式、数据口径与独立预期一致	受控数据集、真实 Worker 与文件存储	NOT_RUN
失败与到期	状态契约：失败分类正确，到期后不能下载	注入可控失败，使用可控时钟或等价机制	NOT_RUN
重启恢复	故障集成：处理期间重启，恢复后状态正确且仅有一个可见最终结果	真实存储与执行代际校验	NOT_RUN
产物可启动	冒烟：运行真实发布产物的启动／版本入口	发布制品，不挂载源码补依赖	NOT_RUN
队列处理达标	性能：按已接受的任务大小、并发和资源预算测量	固定环境，预算确认后填写	NOT_RUN

text

Given：同一认证主体提交 request_id=REQ-DEMO-01，参数摘要 H1。
When：任务已提交，第一次响应丢失；客户端在原作用域仍获授权且请求映射保留期内重载并查询原请求。
Then：查回同一任务 ID，展示服务端返回的合法实际状态，任务总数仍为 1；客户端没有发起新的提交。
说明：任务可能已完成，不固定断言为 QUEUED/RUNNING；
若专门验证在途状态，夹具须明确控制 Worker 的执行时序。
本用例负控：临时让重载丢失原 request_id，或让恢复路径重新提交；
            原请求查回或新增提交次数的断言应失败。
并发重复用例负控：临时破坏去重保护，执行多次同键写入；
                  任务计数应捕获重复，未捕获须检查变异与判据。
每次负控后精确恢复，再重新验证。

A.12 数据库变更与迁移方案示例

markdown

# 导出任务存储变更
状态：设计，未执行。
新增：任务表、请求映射、租约与执行代际；具体类型按数据库契约确定。
唯一约束：(tenant_id, actor_id, request_id)，字段非空。

向前顺序：先执行兼容的新增迁移 → 部署可识别新表的服务 → 开启入口。
权限：API 与 Worker 使用各自最小运行权限；迁移使用单独身份。
核验：唯一约束、运行 ACL、已有业务不受影响、重复迁移符合工具语义。

恢复：
- 新表已有任务时不直接 DROP；
- 先停止受理，处理／记录在途任务，确认旧代码兼容性；
- 是否允许 down 由数据前提与演练决定；不能保证时采用向前修复。

A.13 Standards / Spec 双轴审查报告示例

markdown

# Review：异步导出候选
基线：<旧稿/旧提交摘要>；候选：<新稿/新提交摘要>。
依据：需求、已接受决定、工程规范、SPEC。
以下为示例发现，不是本项目实测结果。

Standards：
- BLOCKER S-01：接口从请求 body 取 actor_id；
  违反身份来源规范，恶意客户端可修改任务作用域。
- 处置：待修；修后检查所有读取与下载入口的认证来源。

Spec：
- BLOCKER R-01：页面重载丢失原 request_id；
  无法满足“响应丢失后查询原任务”的验收准则。
- 处置：待修；补持久化与重载用例，独立复核不产生新提交。

文档核查：
- 决定状态仍为 Proposed 时，不得宣称已裁定；
- 测试计划中真实/模拟依赖与实际入口一致；
- 未覆盖的性能、部署与告警验证保留 OPEN。

A.14 验证记录 (EVIDENCE) 归档示例

markdown

# 导出验收证据
状态：NOT_RUN（模板，尚未执行）。
受测版本：<完整 SHA / 内容摘要>。
配置与依赖：<数据库/浏览器/运行身份类别/配置摘要>。
命令：<实际执行入口>；退出码：N/A。
结果：未执行；不能填写预期的通过数量。

执行后补充：
- 先红：原始输出、对应目标与失败位置；
- 转绿：实际统计与日志；
- 变异测试：变异内容、实际失败与精确恢复摘要；
- 相同内容的最终检查：实际结果与输入一致性；
- 浏览器/真实依赖边界、skip、异常与 OPEN。

证据地址：<实际可访问的日志/截图/Trace 路径>。

A.15 发布清单与部署回执模板

发布清单记录获准部署的组合，部署回执记录实际结果。两者可以保存在同一文件的不同记录区，通过 ID 关联；追加回执时不改写已固化的清单。

markdown

# 发布清单：REL-EXAMPLE-01
状态：候选，尚未验收或发布；所有结果初始为 NOT_RUN。
清单版本与摘要：<准入后填写>；生成时间：<带时区>。
目标用户、环境与范围：<填写>；版本负责人：<填写>。
适用审批：<负责人、批准依据与时间；不适用时说明>。

源码与构建：
- 仓库/模块：<名称>；源码：<完整 Commit SHA>。
- 构建记录：<工具链、依赖锁定、参数、环境与日志引用>。
- 制品：<镜像 Digest 或文件及完整校验和>；按实际数量逐项记录。

契约、配置与数据：
- 接口/消费者兼容范围、运行时与外部依赖：<填写>。
- 配置版本或摘要、开关状态：<填写>；密钥仅记录受控引用。
- 迁移基线、文件校验和、执行身份与顺序：<填写>。

准入与执行：
- 隔离验收证据、受测组合与结论：<真实记录>。
- 必备范围与阻断项：<逐项核对>。
- 非阻断 OPEN：<影响、接受人、后续负责人及期限>。
- 发布步骤与批次、健康/业务探针、停止阈值：<填写>。
- 恢复策略、前提、演练证据和责任人：<填写>。
- 运维接手人、告警与支持安排、发布说明：<填写>。

# 部署回执：<独立 ID，实际执行后填写>
引用清单：<已固化清单 ID、版本与摘要>。
执行人、目标环境、开始及结束时间：<实际记录>。
实际制品、配置和迁移结果：<实际记录>。
结果：<成功/失败/部分完成/结果未知；不提前填成功>。
探针与业务核验：<实际结果及证据>。
异常、停止或恢复：<动作、数据核验、当前状态和责任人>。
运行交接：<接收确认与剩余问题>。
效果观察：<引用 A.22 的负责人、窗口及后续结论>。

A.16 运维手册与故障处置 (Runbook) 示例

markdown

# 导出积压处理
触发：队列最老任务等待时间超过项目已接受阈值。
观察：队列长度、最老任务、执行时长、失败分类、租约与 Worker 存活。
告警：接收渠道、当班责任人、确认与升级时限均需配置并验证。

处理：
1. 核对正在运行的制品、配置和数据库状态。
2. 区分任务过大、存储失败、Worker 异常和租约问题。
3. 需要停受理时使用既定开关，保留任务与请求映射。
4. 恢复前确认执行代际，避免旧 Worker 覆盖新结果。
5. 验证处理进度、唯一结果、权限与告警恢复。

禁止将批量删除任务作为默认“清积压”动作。
演练状态：NOT_RUN；阈值和操作命令在项目采纳时补齐。

A.17 复盘与知识更新示例

markdown

# 示例复盘：重复导出
状态：假设场景，用于展示复盘结构。
现象：响应丢失后客户端创建新 request_id，生成了两个任务。
需收集：客户端请求、服务端受理记录、任务状态、关联时间线。
根因判定：只有证据能关联上述链路后，才确认新键重发是原因。

改进：
- SPEC 明确未知结果恢复流程；
- 页面保存原请求身份；
- 增加响应丢失 + 重载 + 独立任务计数测试；
- 审查模板增加“未知不等于失败”的检查点；
- 若保留期决定变化，新增 ADR 并关联旧决定。

验证与负责人：逐项登记；不要以“提醒大家注意”关闭复盘。

A.18 Agent 执行授权、审计与停止演练示例

本例约束的是负责实现报表导出功能的编码 Agent，不要求报表业务本身具备 Agent 能力。以下为待项目采纳的任务边界记录模板：

markdown

# T-001：编码 Agent 执行边界与授权记录
状态：Proposed；控制验证：NOT_RUN；实际授权：尚未授予。
人类所有者：<填写实际任务所有者与应急联系人>
授权依据：任务卡 T-001 发起记录及现行项目授权范围
运行关联：task=T-001；run=<执行器生成的 UUID>；agent=coder-export
执行身份：专用本地测试身份 (test-runner)；严禁继承个人生产凭据或全量浏览器 Session

允许动作范围（须由维护者填入真实资源标识）：
- 读写当前任务专属的隔离 Worktree 工作目录；只读本项目现行规范文件；
- 运行该工作目录下的原生构建与测试脚本；
- 连接并重建归本任务专有的 export_test_T001 测试数据库；
  (执行前核对主机地址、DB 名称与所有权 Tag，严禁仅按模糊前缀匹配)；
- 浏览器仅登录合成测试账号，访问已登记的本地端点（localhost）；
- 模型上下文数据遵循项目数据发送策略：凭据、真实客户数据与未核准文档严禁发送。

明确越权动作（严禁执行）：
- 生产环境访问、共享集成库重建、对外发送通知消息、镜像发布部署、
  新增未登记网络出口、放宽当前门禁或修改审计日志文件。

资源与调用预算：
- 本轮最长执行 60 分钟；最多分派 2 个并行子任务；
- 父子任务合计上限 100 次有副作用的工具调用（含失败重试）；
- 预算由执行器以原子操作扣减共享配额，到期自动暂停，重启无法续期。

停止与应急责任：
- 停止责任人：<填写实际可执行停止操作的负责人>
- 停止入口：<实际已验证的停止命令或管理控制台入口>
- 事实核查身份：只读查询任务表与执行器审计日志，严禁执行修复写入
- 日志保留位置：<任务执行身份无法删改的受保护存储>；审计保留期限：<按项目数据规则填写>
- 临时例外：无 (新增例外须记录范围、批准人与到期时间)

将上述文本约束落地为实际控制机制（由维护者配置）：

管控目标	实际控制配置	验收与测试动作
工作区与库隔离	沙箱仅挂载任务工作目录；数据库连接串仅授权测试库	写入测试标记成功；尝试写入隔离区外文件被 OS 权限拒绝
数据目的地限制	锁定获准的模型服务端点；受控工具网络出口白名单	向未获准的测试接收端发送标记数据，网络出口强制丢包拦截
并发与调用预算	执行器按 task/run 绑定配额，工具调用前原子扣减	临时设预算为 2 次，发起 3 个原本合法的并发动作；确认恰有 2 次执行，其余被拒；不依赖并发完成顺序
操作可审计留痕	执行前后分别记录，目标动作绑定唯一 Operation ID	比对任务库状态与执行日志，确认调用次数与操作身份严格吻合
停止与未知状态	关闭新增准入、吊销临时授权，仅保留受限事实核查通道	在写入提交但回执丢失时停止并查回状态；再尝试原本获准的新标记动作，确认因停止被拒且无新增副作用；适用的后台或子任务已退出或排空

text

结构化审计事件格式示例：
事件 1 (放行执行): 
  task=T-001 run=R-DEMO operation=OP-DEMO actor=coder-export
  tool=test_db.write_marker target=<已核验测试库 ID>
  authorization=<有效授权引用> policy=v1.2 decision=ALLOW
  state=DISPATCHED params=<脱敏参数摘要>
事件 2 (回执丢失): 
  task=T-001 run=R-DEMO operation=OP-DEMO state=UNKNOWN reason=REPLY_TIMEOUT
事件 3 (状态对齐): 
  operation=OP-DEMO actor=auditor-readonly state=RECONCILED
  result=<目标库真实记录引用> side_effects_count=1

A.19 需求收集与澄清示例

markdown

# REQ-EXAMPLE-001：大报表导出后，用户能确认请求与结果
状态：待澄清；需求负责人：<项目采纳时填写>。
说明：本条为虚构示例，不代表已访谈用户或已批准排期。

来源：<访谈、客服工单或运行证据的受控链接与日期>。
问题假设：同步导出容易超时；响应丢失后，用户无法确认是否已受理。
受影响对象：有报表查看权限、需要导出大报表的用户。
现有替代操作：<待调查，不假定用户一定会重复提交>。
业务目标：让用户能确认原请求并取得有权访问的导出结果。
效果指标：导出结果确认成功率、重复提交相关求助量；统计口径待确认。
当前基线：待采集；目标值与观察窗口：待确认，不填模拟数据。
范围：CSV 提交、原请求查询、进度和安全下载。
非目标：Excel、定时导出、邮件发送和批量共享。

验收草案：引用快速上手 AC-01～AC-06，需求简报见 A.3。
风险：涉及权限与持久化，按 L3 准备审查和验证。
未决：D-EXAMPLE-001 的去重期限、保留期限、最大规模与数据读取口径。
下一步：核查问题证据，确认目标和未决规则，再进入候选队列。
关联：任务卡 T-001；排序见 A.20；版本计划见 A.22。

A.20 优先级与取舍记录示例

markdown

# 导出能力候选排序
状态：讨论稿；负责人：<填写>；复查时间或触发条件：<填写>。
本示例只展示取舍方式，不代表真实评分或批准结果。

候选项：
- REQ-EXAMPLE-001：异步 CSV 导出与原请求恢复。
- REQ-EXAMPLE-002：Excel 格式导出。
- REQ-EXAMPLE-003：导出邮件通知。

前置约束：
- 001 中的权限检查、幂等和恢复共同构成安全可交付范围；
- 待决策的期限与规模先澄清，不能由执行 Agent 自行补值；
- 002/003 是其他能力，不得用高评分挤掉 001 的必要安全验证。

暂定顺序：先验证并细化 001；002/003 暂缓，补充需求证据后重评。
理由：先形成一个可用的导出闭环，避免同时扩展格式与通知渠道。
RICE：暂不评分；覆盖人数、影响和总投入尚无可比证据。
最终决定：待需求负责人确认；如沿用既有授权决定，填写引用。
影响：未承诺发布日期；未授权发送邮件或启用新外部服务。

A.21 迭代计划与变更记录示例

markdown

# ITER-EXAMPLE-01：导出受理与原请求查询
状态：候选计划；不是已开始的迭代。
周期：<起止日期/批次边界与时区>；负责人：<填写>。
本轮目标：对重复提交和原请求查询给出一致、可核验的服务端结果。
关联需求：REQ-EXAMPLE-001；目标版本：REL-EXAMPLE-01。

准入前提：需求与关键规则已确认；适用规格审查通过；测试资源可用。
本轮范围：T-001 / S1；验收映射与未交付边界沿用快速上手切片表。
不在本轮：Worker 生成、完整页面及生产发布。

容量记录：
- 人员可用时间、值班/请假：<填写>；
- 领域审查与复核窗口：<填写>；
- 实现、测试、真实依赖集成、返工预算：<填写，避免重复扣减>；
- 独立数据库、CI、并发工作目录与工具预算：<填写>；
- 估算区间、依据与待验证假设：<填写>。

顺序：关键决策 → 契约确认 → S1 的 TDD 与验证 → 独立审查 → 合入。
在制上限：开发 <数量>、审查 <数量>、验证 <数量>；由实际容量确定。
重排记录：变更原因、决定人、加入项、移出项、目标和版本影响。
结束记录：已验证结果、未完成项及原因、重新排序、下一轮改进。
边界：即使 S1 通过，也不将 REL-EXAMPLE-01 标为可发布。

A.22 版本计划与效果评估记录示例

markdown

# REL-EXAMPLE-01：用户可恢复的异步 CSV 导出
状态：候选版本；未承诺时间、未发布。
需求来源：REQ-EXAMPLE-001；版本负责人：<填写>。
路线图位置：<Now/Next/Later 或约定窗口>；依据：<填写>。
目标用户与环境：<内部演练/受控试用/生产，按实际批准范围填写>。
目标窗口、预测依据与信心：待填写；对外承诺需另记主体与依据。

必备范围：
- S1 受理与查询、S2 执行与结果、S3 用户端闭环；
- 同键处理、权限、到期、未知结果与重启恢复；
- 目标环境的容量、运行观测、发布和恢复验收。
可调整范围：不影响安全与基本可用性的展示优化，逐项确认。
非目标：Excel、邮件发送、定时导出与批量共享。

依赖：D-EXAMPLE-001；真实存储、身份与权限、文件存储配置。
仓库与制品：<按实际组合填写，单仓无需虚构多仓依赖>。
迭代安排：ITER-EXAMPLE-01 完成 S1；后续切片按容量滚动规划。
发布退出条件：引用 AC、测试计划、运行手册及各项实际证据。
停止与恢复：<条件、前置、动作与责任人>。
发布记录：先按 A.15 登记候选组合，验收并准入后固化清单；实际部署回执另行追加。

效果评估记录：
- 观察负责人、数据来源、统计窗口：<填写>；
- 发布前基线、目标、实际结果：<有实测依据后填写>；
- 当前结论：尚未观察，不能判定达标；
- 后续动作：继续观察/改善/退出，记录理由与关联需求。

附录 A：常用文档模板（贯穿式业务示例） ​

A.1 README / 文档索引示例 ​

A.2 AGENTS / 工程规范示例 ​

A.3 需求说明（Intent / PRD）示例 ​

A.4 术语 / 领域模型 / 架构示例 ​

A.5 技术方案 / RFC 示例 ​

A.6 D-ID / ADR 决策记录示例 ​

A.7 SPEC / 接口契约示例 ​

A.8 UI / 交互与无障碍示例 ​

A.9 安全与威胁模型示例 ​

A.10 实施计划与切片示例 ​

A.11 测试策略与用例设计示例 ​

A.12 数据库变更与迁移方案示例 ​

A.13 Standards / Spec 双轴审查报告示例 ​

A.14 验证记录 (EVIDENCE) 归档示例 ​

A.15 发布清单与部署回执模板 ​

A.16 运维手册与故障处置 (Runbook) 示例 ​

A.17 复盘与知识更新示例 ​

A.18 Agent 执行授权、审计与停止演练示例 ​

A.19 需求收集与澄清示例 ​

A.20 优先级与取舍记录示例 ​

A.21 迭代计划与变更记录示例 ​

A.22 版本计划与效果评估记录示例 ​

附录 A：常用文档模板（贯穿式业务示例）

A.1 README / 文档索引示例

A.2 AGENTS / 工程规范示例

A.3 需求说明（Intent / PRD）示例

A.4 术语 / 领域模型 / 架构示例

A.5 技术方案 / RFC 示例

A.6 D-ID / ADR 决策记录示例

A.7 SPEC / 接口契约示例

A.8 UI / 交互与无障碍示例

A.9 安全与威胁模型示例

A.10 实施计划与切片示例

A.11 测试策略与用例设计示例

A.12 数据库变更与迁移方案示例

A.13 Standards / Spec 双轴审查报告示例

A.14 验证记录 (EVIDENCE) 归档示例

A.15 发布清单与部署回执模板

A.16 运维手册与故障处置 (Runbook) 示例

A.17 复盘与知识更新示例

A.18 Agent 执行授权、审计与停止演练示例

A.19 需求收集与澄清示例

A.20 优先级与取舍记录示例

A.21 迭代计划与变更记录示例

A.22 版本计划与效果评估记录示例