附录 B 可直接复用的模板
团队日常工作中可直接复用的任务简报、文档模板、代码评审指南与标准化交付物模板集合,帮助提升团队协作效率,并说明使用方法。
以下模板建议放入团队仓库并通过真实任务迭代。不要把模板当作一次写完的规范大全。
B.1 通用任务 Brief
# 目标
# 背景 / 为什么现在做
# 范围
- 包含:
- 不包含:
# 输入与参考
- 文件 / Issue / Spec / 截图:
# 约束
- 架构:
- 数据与权限:
- 依赖与成本:
- 禁止动作:
# 验收
- 功能:
- 异常:
- 权限:
- 性能:
- 测试 / build:
# 输出
- 代码 / 文档 / 表格 / PR:
- 证据:
- 风险与回滚:
B.2 项目根 AGENTS.md 模板
# 项目与业务边界
# 术语与核心流程
# 唯一正确命令
- dev:
- test:
- lint:
- typecheck:
- build:
- migrate:
# 架构不变量
# 数据、权限与敏感信息
# Git / 分支 / Worktree / PR
# 必跑验证与发布门禁
# 外部系统与写操作审批
# 常见坑与安全替代路径
# 规则与 Skills 的 Owner / 更新时间
B.3 CLAUDE.md 兼容引用
@AGENTS.md
B.4 目录级 AGENTS.md 模板
# 模块职责与边界
- 本目录负责:
- 不负责:
# 模块约定
- 允许修改:
- 禁止修改:
# 验证
- 必跑测试:
- 异常与权限路径:
## Code Review Rules
- 优先检查正确性、授权、数据完整性、异常与测试缺口
- 发现必须引用具体文件与证据,不把猜测写成缺陷
B.5 通用 SKILL.md
---
name: <skill-name>
description: <何时触发;核心任务;什么时候不要触发>
---
# 目标
# 必需输入
# 前置检查
# 执行步骤
1.
2.
3.
# 输出格式
# 验证
# 权限与禁止事项
# 失败与人工接管
# 示例与参考
B.6 长时间 Goal 模板
/goal
结果:完成【明确结果】。
范围:
- 包含:
- 不包含:
约束:
- 可写目录:
- 允许命令:
- 禁止外部副作用:
- 预算 / 时间:
里程碑:
1. 现状与计划
2. 最小实现
3. 验证与修复
4. Review 与文档
完成条件:
- 测试 / 构建:
- 功能与异常:
- 证据:
- 风险与回滚:
遇到以下情况暂停并请求决策:
- 规格冲突
- 需要新增生产依赖
- 需要生产或高敏权限
- 超出预算 / 时间
B.7 代码评审模板
请基于当前 Diff、SPEC 和项目规则做独立评审。
优先级:
1. 正确性与数据一致性
2. 认证、授权与敏感信息
3. 异常、并发、幂等与回滚
4. 兼容性、迁移与性能
5. 测试缺口与可观测性
6. 可维护性
每个发现必须包含:
- 严重度:Blocker / High / Medium / Low
- 文件与位置
- 可复现或逻辑证据
- 实际影响
- 最小修复建议
- 回归验证
不要把风格偏好或无法证实的猜测写成缺陷。
B.8 产品研究 Brief
# 决策问题
# 决策截止时间
# 目标用户与地区
# 时间窗口
# 竞品与替代方案
# 现有证据
# 必须补齐的证据
# 事实 / 推断 / 建议的区分规则
# 输出:矩阵、机会、反证、MVP、停止条件
# 图片 / Demo 采集范围与版权要求
B.9 事务自动化发布检查
- 来源、时间范围和原始文件已标明。
- 事实、判断、建议、待确认已分开。
- 目标群 / 文档 / 收件人 / 租户 / 环境已显示。
- 敏感内容、客户名称、金额、日期和 owner 已人工检查。
- 重复运行不会重复发送或覆盖错误对象。
- 失败会保存草稿并返回错误、部分副作用和恢复步骤。