在编程领域,AI IDE工具正变得越来越流行,它们能够帮助开发者更高效地编写代码。然而,要充分利用这些工具,你需要构造一套规范文档和详细的需求说明。这就像教导一个聪明但不了解代码最佳实践的孩子,你需要清楚地告诉AI你想要什么。
一、如何构建规范文档和需求说明
项目需求文档
项目需求文档是项目的蓝图,它概述了项目的整体内容,包括
-
项目简介
-
问题陈述
-
解决方案
-
目标用户
-
技术栈
-
核心功能
-
工作范围
这份文档为你的项目提供了一个简要介绍,并指导AI完成每一步。根据CodeGuide,这个工具可以帮助用户生成详细的项目文档,包括产品需求文档(PRD)和技术栈等。
应用流程与功能文档
这份文档描述了应用的完整端到端运行流程,类似于向朋友解释你的应用。它为AI提供了一个规划每个页面执行的图表/蓝图。
提示:在编写时要求 AI 在该文档中应避免使用项目符号,以确保文档的清晰和连贯性。
技术栈与依赖包文档
这份文档为AI提供了技术背景,详细说明了构建应用所需的技术栈。选择常用的技术栈很重要,因为像Claude和GPT-4这样的大型语言模型主要基于广泛使用的框架进行训练。
你的项目是否使用 Python?或者 Nextjs?后端用 Supabase 还是 Firebase?
此文档将详细说明 AI 需要使用的技术栈以构建你的应用。
确保选择常用的技术栈,因为像 Claude 和 GPT-4 这样的 LLMs 主要基于广泛使用的框架进行训练。
我使用 Nextjs 14、TaliwindCSS、shadcnUI 和 radixUI 作为前端,Supabase 作为后端。
以下平台都偏好这种技术栈:
-
v0.dev
-
bolt
-
Claude
-
Cursor
-
Replit
Python 对于不需要现代 UI 的高性能应用来说是快速开发的不二选择。
文件结构文档
为了避免不断出错的恶性循环,这份文档至关重要。它提前提供了文件结构,确保AI不会创建重复文件,将文件保存到错误位置,或删除已完成的代码。建议以ASCII格式创建文件结构,并截图保存文件结构,附加到文档中。
API文档
AI默认不知道任何平台的API是如何配置的。因此,我们需要附加将要在应用中使用的所有API的文档,例如OpenAI API、Claude API文档、Supabase文档等。从它们的网站复制指令并粘贴到你的文档中,然后将该文档附加给AI。
后端架构设计文档
架构基本上是你的后端蓝图,包含需要创建的所有数据库表、存储桶以及用户信息表(认证)。使用Supabase,AI能够生成可以直接在Supabase中运行的SQL查询,几秒钟即可完成。通过这种方式,可以在一小时内创建数据库并将其附加到前端。
亮点:Claude 在设计后端架构方面表现出色,如果你创建了合适的文档,AI 会轻松遵循指导。
.cursorrules文件
.cursorrules文件类似于ChatGPT的自定义指令,需要针对项目而非通用的“AI规则”提示。根据技术栈和项目需求,要求AI创建一个.cursorrules文件。此文档将告诉AI各个文档的位置(Cursor的导航地图)。
UI布局文档
这份文档会让你的前端界面更美观。如果与v0配合使用,可以创建具有一致风格的前端组件。
此文档应包含以下信息:使用的UI包、字体、配色方案、图标、效果等。
苏米站内有整理了非常多的开源UI组件库、图标库、开源UI框架等,可以直接复用,只需要稍加阅读文档就可以做好产品的UI选型。
系统提示词
可以要求AI为v0、bolt或任何你可能使用的工具创建项目特定的系统提示词。这有助于与工具进行沟通,并且不需要每次提供较长的上下文。优秀的系统提示词能够提升AI在平台上的表现。
二、CURSOR编程的规范文档构建
CURSOR AI编程工具通过一系列规范化文档和详细说明,帮助开发者构建高质量的软件项目。通过定义清晰的上下文边界和提供详尽的输入文档,CURSOR能够减少错误、提高开发速度,并确保项目的可扩展性和流畅的用户体验。这些文档不仅为AI提供了必要的信息,也为项目团队提供了沟通和协作的基础。
上下文边界(Context Boundary)
在AI编程中,上下文边界是确保AI理解项目需求和限制的关键。CURSOR工具通过以下文档来定义这个边界:
-
PRD (Project Req. Doc.) - 项目需求文档,详细描述项目目标、用户需求和预期成果。
-
App Flow Doc. - 应用流程文档,展示应用的工作流程和用户交互流程。
-
Schema Design Doc. - 数据模型设计文档,定义数据库结构和数据关系。
-
Tech Stack & Packages - 技术栈和依赖包文档,列出项目中使用的技术、框架和库。
-
Frontend Code - 前端代码,实现用户界面和用户体验。
-
API Docs - API文档,详细说明后端服务和接口。
AI编码速查表(AI Coding Cheatsheet)
使用CURSOR工具,您可以期待以下结果:
-
90% Less Errors - 减少90%的错误,提高代码质量。
-
Less AI Hallucinations - 减少AI生成的不准确或不相关的代码。
-
Quality Code Structure - 确保代码结构的高质量和可维护性。
-
Fast Project Development - 加快项目开发速度。
-
Easy Frontend x Backend Integration - 简化前后端集成。
-
Scalable App Structure - 构建可扩展的应用结构。
-
Less Tokens Burned - 减少AI处理过程中的资源消耗。
-
Fluid UI/UX - 实现流畅的用户界面和用户体验。
CURSOR工具的输入文档
为了最大化CURSOR工具的效能,您需要提供以下输入文档:
-
.curorrules File - 自定义规则文件,指导AI如何根据项目需求进行编码。
-
PRD (Project Req. Doc.) - 项目需求文档。
-
App Flow Doc. - 应用流程文档。
-
Tech Stack & Packages - 技术栈和依赖包文档。
-
Frontend Code - 前端代码。
-
Schema Design Doc. - 数据模型设计文档。
-
API Docs - API文档。
-
System Prompts for v0 - 为特定工具或版本定制的系统提示词。
三、借助CodeGuide辅助编写文档
CodeGuide 是一个旨在为AI编程项目创建详细文档的平台。它通过一个简单、流程化的步骤,帮助用户从注册到下载文档,只需几个步骤即可完成。
主要功能:
-
文档生成:CodeGuide 能够为AI编程项目生成详细的项目文档,包括产品需求文档(PRDs)、技术栈等。
-
AI辅助:利用AI技术帮助用户完善和清晰化项目想法。
-
兼容性:与所有主要的AI编程工具兼容,如Claude AI、Cursor等。
-
问卷调查:通过完成一个简短、集中的问卷,CodeGuide 可以填补信息空白,为文档创建详细的大纲。
-
文档编辑:用户可以编辑或完善生成的文档的任何部分。
-
模板访问:提供40多个现成的模板供用户使用。
-
模型和支持:提供对o1-preview模型和Claude的访问,以及专门的支持和社区。
-
项目管理:允许用户每月启动多达15个项目。
使用场景:
-
为AI编程项目创建和管理文档。
-
利用AI技术优化项目想法和文档清晰度。
-
与现有的AI编程工具集成,提高开发效率。
-
在项目规划和开发过程中,使用现成的模板快速启动。
优点:
-
简化流程:通过简化的流程,快速生成项目文档。
-
AI辅助:利用AI技术提高文档质量和项目想法的清晰度。
-
灵活性:提供月度和年度订阅计划,用户可以根据需要灵活选择。
-
兼容性:与多种AI编程工具兼容,扩大了其适用性。
-
用户支持:提供专门的支持和社区,帮助用户解决问题。
-
模板丰富:提供多种模板,方便用户快速开始项目。
缺点:
-
学习曲线:对于不熟悉AI工具或CodeGuide平台的用户,可能需要一段时间来学习如何有效使用。
-
依赖AI:虽然AI辅助是一个优点,但过度依赖可能会限制用户的创造性和批判性思维。
-
成本:虽然提供了灵活的订阅计划,但对于预算有限的个人或小团队来说,可能会有一定的成本压力。
-
技术限制:AI生成的文档可能需要人工审核和调整,以确保完全符合项目需求。
总结
在开发过程中,80%的时间用于创建文档,而在剩下的20%时间里取得了很好的成果。所以撰写AI开发需求文档,以便附加给AI,包括系统提示词、PRD文档、架构设计、应用流程文档和UI布局文档等。通过这些详细的文档和规范,AI IDE工具才能够更有效地协助开发者编写高质量的代码。