AI个人学习
和实操指南

正确使用AI IDE工具编程,你需要构造一套规范文档和详细需求说明

就像一个聪明但不了解代码最佳实践的孩子。

你需要清楚地告诉 AI 你想要什么:

  • 是 web 应用吗?
  • 需要什么功能?
  • 结构是什么?
    等等。

以下是如何让 AI 成为你的全栈开发者的方法:


AI编写程序=规范化文档+详细说明-1

 

上下文至关重要!

你需要为 AI 建立一个强大的上下文屏障。

目标:不要让 AI 做出任何假设。所有信息都由你提供。

通过这种方式,AI 会与你协作,而不是对抗你。

接下来讨论需要附加哪些文档,以提供最大化的上下文支持。

AI编写程序=规范化文档+详细说明-1

 

1. 项目需求文档

此文档概述了项目的整体内容:

  • 项目简介
  • 问题陈述
  • 解决方案
  • 目标用户
  • 技术栈
  • 核心功能
  • 工作范围

该文档是你项目的简要介绍。

接下来添加更具体的文档,以指导 AI 完成每一步。

 

2. 应用流程与功能文档

想象一下,你正在向朋友解释你的应用:

“当用户注册后,会跳转到仪表板。在仪表板上,有 4 个部分:指标部分、分析部分等。”

此文档提供了应用的完整端到端运行流程。

提示:要求 AI 在该文档中 不要使用项目符号

此文档非常重要,因为它为 AI 提供了一个规划每个页面执行的图表/蓝图。

 

3. 技术栈与依赖包文档

现在为 AI 提供技术背景。

你的项目是否使用 Python?或者 Nextjs?后端用 Supabase 还是 Firebase?

此文档将详细说明 AI 需要使用的技术栈以构建你的应用。

确保选择常用的技术栈,因为像 Claude 和 GPT-4 这样的 LLMs 主要基于广泛使用的框架进行训练。

我使用 Nextjs 14、TaliwindCSS、shadcnUI 和 radixUI 作为前端,Supabase 作为后端。

以下平台都偏好这种技术栈:

Python 对于不需要现代 UI 的高性能应用来说也很不错。

 

4. 文件结构文档

如果你不想进入不断出错的恶性循环,此文档至关重要。

AI 可能会创建重复文件,将文件保存到错误位置,甚至删除已完成的代码。

为解决此问题,请提前提供文件结构。

提示:确保要求 AI 以 ASCII 格式创建文件结构。

截屏保存文件结构,并将其附加到文档中。

 

5. API 文档

AI 默认情况下不知道任何平台的 API 是如何配置的。

我们需要附加将要在应用中使用的所有 API 的文档。

例如 OpenAI API、Claude API 文档、Supabase 文档等。

从它们的网站复制指令并粘贴到你的文档中,然后将该文档附加给 AI。

 

6. 后端架构设计文档

架构基本上是你的后端蓝图。

它包含需要创建的所有数据库表、存储桶以及用户信息表(认证)。

我使用 Supabase,因为 AI 能够生成你可以直接在 Supabase 中运行的 SQL 查询,几秒钟即可完成。

通过这种方式,我可以在一小时内创建我的数据库并将其附加到前端。

亮点:Claude 在设计后端架构方面表现出色,如果你创建了合适的文档,AI 会轻松遵循指导。

 

7. .cursorrules 文件

许多人没有使用这个工具。它类似于 ChatGPT 的自定义指令。

.cursorrules 文件需要针对项目而非通用的“AI 规则”提示。

根据技术栈和项目需求,要求 AI 创建一个 .cursorrules 文件。

此文档将告诉 AI 各个文档的位置(Cursor 的导航地图)。

通过此文件帮助 AI 更高效地导航。

 

8. UI 布局文档

此文档会让你的前端界面更美观。如果与 v0 配合使用,可以创建具有一致风格的前端组件。

大多数人低估了干净用户界面(UI)的力量。

“第一印象很重要。”

此文档应包含以下信息:使用的 UI 包、字体、配色方案、图标、效果等。

 

9. 系统提示词

可以要求 AI 为 v0、bolt 或任何你可能使用的工具创建项目特定的系统提示词。

这有助于与工具进行沟通,并且不需要每次提供较长的上下文。

你知道为什么 Claude 在其平台上的表现优于通过 API 的使用吗?因为他们的系统提示词非常优秀。

为你的项目做同样的事情,你会与 AI 成为更好的朋友。

我在开发过程中将 80% 的时间用于创建文档,而在剩下的 20% 时间里取得了很好的成果。

 

介绍:codeguide.dev

一个帮助你集思广益并撰写所有重要文档的应用,以便附加给 AI。

✅ 系统提示词
✅ PRD 文档
✅ 架构设计
✅ 应用流程文档
✅ UI 布局文档
等等

 

链接http://codeguide.dev

AI轻松学

普通人的AI入门指南

帮助你以低成本、零基础学会如何利用AI工具。AI就像办公软件一样,是每个人的必备技能。 掌握AI会让你在求职中占据优势,在未来的工作和学习中事半功倍。

查看详情>
未经允许不得转载:首席AI分享圈 » 正确使用AI IDE工具编程,你需要构造一套规范文档和详细需求说明

首席AI分享圈

首席AI分享圈专注于人工智能学习,提供全面的AI学习内容、AI工具和实操指导。我们的目标是通过高质量的内容和实践经验分享,帮助用户掌握AI技术,一起挖掘AI的无限潜能。无论您是AI初学者还是资深专家,这里都是您获取知识、提升技能、实现创新的理想之地。

联系我们
zh_CN简体中文