--- title: "设计文档优先" type: concept tags: [vibe-coding, workflow, planning, documentation] --- ## 定义 在交给 AI 生成代码之前,先完成完整的技术设计文档(含伪代码),再由 AI 执行实现。vibe coding 工程化的核心原则。 ## 工作流 ``` 需求 → 设计文档(含 service 层伪代码) → AI 直出代码 → AI review → 修改提交 ``` ## 设计文档应包含的内容 - **模块划分**:每个模块的职责边界 - **接口定义**:模块间 API/函数签名 - **伪代码**:核心逻辑的实现步骤(降低 AI 推理难度) - **技术选型**:明确使用的库/框架/版本 - **上下游链路**:模块与其他系统/服务的依赖关系 ## 核心价值 - AI 直出质量与设计文档质量正相关 - 伪代码将"创意"转化为"可执行步骤",减少 AI 幻觉 - 文档本身是团队知识沉淀,不依赖 AI 执行才存在 ## 与传统开发的区别 | 维度 | 传统开发 | 设计文档优先 | |------|---------|------------| | 代码生成 | 人写 | AI 生成 | | 架构决策 | 人做 | 人做(通过文档) | | 单元测试 | 人写 | AI 生成 | | review | 人做 | AI + 人 | ## 在 vibe coding 中的位置 [[Vibe Coding]] = 规划驱动(设计文档)+ AI 结对执行 + 上下文固定。设计文档优先是"规划驱动"的具体实践。 ## Aliases - Design Doc First - 伪代码前置 - 设计先行