跳转至

FDE 项目模板

每个项目复制本页,持续更新。空白项代表未知,不要用推测填充。

1. 项目摘要

项目 内容
业务负责人
技术负责人
用户与频率
当前流程
目标结果
明确不做
上线日期

2. 验收标准

维度 指标 基线 目标 数据来源
业务
质量
时延
成本
安全

3. 数据与权限

  • 数据源、所有者和更新频率:
  • 敏感级别与允许地域:
  • 用户、租户和文档权限:
  • 日志字段、脱敏和保留期限:
  • 删除、纠正和索引重建流程:

4. 架构决策

决策 选项 选择 原因 验证方式
模型
API/自托管
RAG
工具/Agent
GPU/云实例

5. 版本清单

app:
model:
model_revision:
tokenizer:
prompt:
index:
embedding:
reranker:
tool_schema:
container:
driver_cuda_rocm:

6. 评测计划

  • 黄金集大小与分层:
  • 确定性检查:
  • 模型 grader 及人工校准:
  • 高风险门禁:
  • 性能与容量矩阵:
  • 通过、阻断和回滚条件:

7. 上线计划

[ ] 安全与隐私审查
[ ] 容量和故障测试
[ ] 1% 灰度
[ ] 业务指标观察
[ ] 逐级扩流
[ ] 回滚演练
[ ] 支持和告警值班

8. 已知限制

限制 影响 发现方式 缓解 所有者

9. 复盘

  • 业务结果与目标差异:
  • 最重要的失败模式:
  • 哪个假设被证伪:
  • 应沉淀的通用资产:
  • 应删除的临时代码或流程:

10. 建议仓库结构

project/
  README.md                 # 目标、边界、最短运行路径
  docs/
    scope.md                # 业务流程、反目标、责任人
    architecture.md         # 数据流、权限与故障域
    adr/                    # 架构决策记录
  app/                      # 业务应用
  configs/                  # 可版本化非密钥配置
  prompts/                  # 提示、schema、few-shot
  evals/
    datasets/               # 版本化评测输入和 rubric
    runners/                # 可重复评测脚本
    reports/                # 汇总报告,原始结果另存
  deploy/                   # Compose、K8s、IaC
  runbooks/                 # 告警、故障、回滚、恢复
  tests/                    # 单元、集成、安全回归

11. README 最短路径

README 首屏应回答:项目解决什么问题、哪些内容明确不做、需要什么权限、如何用五条以内命令启动、怎样运行 smoke test、怎样停止和清理。之后再链接详细架构与长文档。

## Quick start
1. 复制 `.env.example` 并填写本地密钥。
2. `docker compose up -d`
3. `python scripts/wait_ready.py`
4. `python -m pytest tests/smoke`
5. `python evals/runners/run.py --suite golden-v3`

## Stop / rollback
- 停止:`docker compose down`
- 回滚:将 `MODEL_ALIAS` 指向 `<previous-version>` 后重新部署

12. 交付物索引

交付物 文件/系统 负责人 最近验证 验证方式
范围与验收 业务签字
数据与权限图 安全复核
部署制品 从零安装
黄金集与报告 一键重跑
监控与告警 告警演练
回滚方案 实际回滚
成本模型 账单对账
已知限制 风险接受

13. 架构决策记录

# ADR-XXX:<决策标题>
- 状态:Proposed / Accepted / Superseded
- 日期与负责人:
- 背景和约束:
- 候选方案:
- 评测证据:
- 决策及理由:
- 接受的代价:
- 回滚方法:
- 何时复审:

14. 运行手册模板

# 告警:推理服务 P95 超过阈值
- 用户影响:
- 仪表盘与查询:
- 先检查:队列 -> 输入长度 -> GPU -> 工具/外部依赖
- 立即止损:限流 / 降级 / 回滚
- 恢复验证:固定 smoke case + 真实失败重放
- 升级联系人:
- 需要保留的证据:request ID、trace、配置、时间线

15. 最终验收会议

会议中由接手团队操作,而不是由原开发者演示。至少现场完成:从零启动、正常请求、权限拒绝、模型故障降级、告警确认、版本回滚、评测重跑。任何一步依赖口头知识,都要回到文档或自动化补齐。

模板原则:空白项保留为空并标注负责人和截止时间。伪造一个“看起来完整”的答案会让未知风险在上线后才暴露。