全栈工程师 · 所需文档清单

对齐 VELA DocForge V4.0 大厂模板库(60 份),工程师主责 6 份核心 + 9 份支撑 + 若干专属扩展。


1. 大厂核心模板中的开发层(20 / 22 / 23 / 25 / 26 / 27)

# 模板 主责 本岗位动作
20 20_技术报告.md 工程师主责 架构图 + 选型理由 + 关键假设
22 22_API接口文档.md 工程师主责 REST/Actions/tRPC 契约
23 23_数据库设计文档.md 工程师主责 schema + ER 图 + 索引 + RLS
25 25_测试用例文档.md 工程师 + QA 共担 单测 / 集成 / E2E
26 26_产品使用手册.md 工程师 + 运营共担 技术部分工程师写,用户部分运营写
27 27_上线CheckList.md 工程师 + reviewer 共担 闸 4 的依据

2. 支撑模板(S10–S21)工程师涉及

# 模板 主责 何时出
S10 埋点验收清单 工程师 + AI PM 有埋点需求时(几乎都有)
S11 灰度发布计划 工程师 + 运营 有灰度需求时
S12 应急预案 工程师 + 质量部 涉敏感数据 / 有 SLA 时
S17 架构图(源文件) 工程师 配套 20 号
S18 数据看板 工程师 + 运营 有运营需求时
S19 性能测试报告 工程师 有性能 SLA 时
S20 Bug 跟踪表 工程师 + 质量部 开发期持续维护
S21 AB 实验报告 工程师 + AI PM 有 AB 实验时
S27 数据采集方法 工程师 + AI PM 涉数据采集时(A/B/C 档判定)

3. 开发专属扩展(大厂模板没覆盖,但一号位必出)

文档 用途 落档位置
README.md 项目怎么跑 / 部署 / 开发 代码仓库根目录
运维手册 上线后怎么改 / 排障 / 回滚 交付物/03_开发层/运维手册.md
环境变量清单 所有 key / secret / config 交付物/03_开发层/环境变量清单.md(脱敏版)+ .env.example(代码仓)
AI 能力集成说明 Prompt / Tool / 模型调用 交付物/03_开发层/AI集成说明.md(涉 AI 必出)
Prompt 管理 固化 Prompt 版本 + 变更记录 交付物/03_开发层/prompts/(涉 AI 必出)
数据采集脚本说明 A 档工具的使用说明 数据扒取部协作

4. 工程师要读(上游交付物)

文档 来源 读什么
18_UI设计规范DesignSystem.md 设计师 设计系统 token
design-tokens.json 设计师 最重要 · 直接 import
17_交互原型文档.md 设计师 页面规格 + 状态集
11_PRD产品需求文档.md AI PM 业务规则
13_功能清单FeatureList.md AI PM RICE 优先级
21_模型选型评估报告.md AI PM AI 能力边界
24_埋点需求文档.md AI PM 埋点规则
16_数据指标体系文档.md AI PM 指标定义
15_业务流程图.md AI PM 复杂业务逻辑

5. 项目类型 × 必出矩阵

项目类型 必出 可选
APP 类(iOS/Android) 20 / 22 / 23 / 25 / 26 / 27 / README / 运维手册 / env / AI集成 / Prompt管理 S10 / S11 / S19 / S20
Web 类 20 / 22 / 23 / 26 / 27 / README / env S18 / S19
小程序类 20 / 22 / 23 / 26 / 27 / README / env S10
文档类 README(若涉脚本生成)
分析报告类 数据处理脚本 README + 采集说明 S27
PPT 类 —(通常不涉开发层)

6. 自查清单(闸 3 前必过)

6.1 代码质量

6.2 安全

6.3 可观测性

6.4 性能

6.5 部署

6.6 文档


7. 禁止