⚠️ Alpha内测版本警告:此为早期内部构建版本,尚不完整且可能存在错误,欢迎大家提Issue反馈问题或建议
Skip to content

5.2 为什么说先写文档再编码——PRD 基础

先写文档的价值

在 Vibe Coding 中,文档不是"交差用的形式主义",而是你与 AI 沟通的核心界面

先写文档的好处

  1. 强迫你想清楚:写不出来说明还没想明白
  2. 减少沟通成本:AI 一次就能理解,不用反复解释
  3. 便于验收:有了文档才知道"做对了没有"
  4. 方便迭代:下次修改时,知道当初为什么这样设计

PRD 文档的基本组成

一份合格的 PRD 应该包含以下元信息:

元素作用示例
文档状态标识文档当前阶段草稿 / 评审中 / 已发布
更新记录追踪变更历史v1.1: 增加了搜索功能
相关文档关联上下游资料技术方案、API 文档
术语表统一概念定义"用户"指已注册账号

文档模板示例

markdown
# [功能名称] PRD

## 文档信息
- **状态**: 草稿
- **版本**: v0.1
- **作者**: [你的名字]
- **最后更新**: 2024-01-15

## 更新记录
| 版本 | 日期 | 变更内容 | 作者 |
|------|------|----------|------|
| v0.1 | 2024-01-15 | 初稿 | xxx |

## 相关文档
- [技术方案](./tech-spec.md)
- [API 文档](./api.md)

## 术语表
| 术语 | 定义 |
|------|------|
| 用户 | 已完成注册的账号 |
| 访客 | 未登录的浏览者 |

## 正文
[功能描述、需求说明...]

本节目标

学完本节,你将掌握:

  1. 文档状态管理:知道一份文档处于什么阶段
  2. 版本记录规范:让每次修改都有迹可循
  3. 文档索引方法:快速找到相关资料
  4. 术语表维护:避免沟通中的概念混乱

记住:写文档不是为了交差,而是为了让 AI 更好地理解你的需求。一份好的文档,就是一份好的 Prompt。