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

5.4 你写的文档 AI 看得懂吗——AI 可读的 PRD

为什么文档格式很重要

在 Vibe Coding 中,文档不仅要让人能读懂,更要让 AI 能"理解"。

好文档 vs 差文档

差文档好文档
"做一个好看的页面""使用 Tailwind,卡片圆角 8px,间距 16px"
"用户登录后跳转""登录成功返回 200,跳转到 /dashboard"
"处理错误情况""密码错误返回 401,格式错误返回 400"

结构化文档的核心要素

一份 AI 友好的 PRD 应该包含:

  1. 明确的输入输出:数据从哪来,到哪去
  2. 具体的约束条件:技术栈、格式、边界
  3. 清晰的异常处理:各种错误情况如何响应
  4. 可验证的成功标准:怎么判断"做对了"

本节目标

学完本节,你将掌握:

  1. 结构化设计:让文档模块清晰、层次分明
  2. 输入输出定义:明确数据流转和接口契约
  3. 边界条件处理:预判异常情况的系统响应
  4. 格式优化:使用 AI 偏爱的 Markdown 格式

记住:写文档就是写 Prompt。文档越清晰,AI 理解越准确,生成的代码就越符合预期。