在使用AI辅助编程时,一个黄金法则需要记住:
别指望AI帮你规划代码库,那是你的工作!
你的任务是动脑子、做规划,而AI的任务是把代码写出来。
想让AI老老实实只写代码?那就得给它准备一个详细的项目知识库,告诉它该干啥。
1. PRD(项目需求文档)
先从这个入手,它能定下整个项目的基调。
需要包含以下内容:
• 应用整体概览
• 用户使用流程
• 技术栈和API
• 核心功能
• 项目范围和非范围事项
这样可以让AI对你要开发的东西有个清晰的大框架认识。
2. 流程文档
你的流程写得越清楚,AI的表现就越好。
具体拆解如下:
• 描述应用里的每一个页面
• 用户如何从一个页面跳转到另一个页面
• 用简单直白的语言
• 细节要写得非常具体
千万别含糊,AI很容易被模糊的描述搞懵。
3. 技术栈文档
得明确告诉AI用什么来开发。
列出以下内容:
• 所有需要的软件包和依赖
• API文档的链接
• 优先使用的库或工具(比如Supabase、Stripe、NextAuth)
这样可以避免AI胡乱“脑补”一些不相关的技术选择。
4. 设计指南
把你的设计要求告诉AI。
需要包含:
• 字体
• 配色方案
• 间距和布局规则
• 优先使用的UI库或框架
• 图标集
如果你想要设计风格统一,就得让AI学会你的视觉语言。
5. 后端结构文档
如果你用的是Supabase或Firebase,这个文档尤为重要。
要告诉AI:
• 数据库结构(DB schema)
• 认证逻辑(Auth logic)
• 存储规则
• 任何可能的边界情况(edge cases)
AI是能写SQL的,但前提是它得知道你想存什么。
6. 实施计划
这是你对抗AI“幻觉”的杀手锏。
列出50个以上的具体步骤,就像你自己手动编码时会做的那样。
把这个计划交给Cursor或Windsurf,它们就只会老老实实执行,不会瞎猜。
你可以用ChatGPT来生成所有这些文档。
我用的是
@CodeGuide,它能自动生成这些文档,专为AI编码模型设计。
它用的是GPT o1/03-mini、GPT-4o和Claude 3.5模型来生成结构化的文档。
这是我实施计划的一个示例:
总结要点:
• AI的任务是执行代码,而不是动脑子
• 你的文档得给AI划好上下文边界
• 这样才能从一团乱麻变成干净利落的开发
• 用
@CodeGuide或
@ChatGPT这样的工具,快速准备好文档
• 然后交给Cursor或Windsurf去写代码
AI可能会把你的代码库搞砸,但如果你提供了详细的上下文,它的表现会让你惊叹。