AI Agent / 系统课时

编写项目上下文说明

编写项目上下文说明

项目上下文说明是 Vibe Coding 中连接开发者意图和 AI 执行能力的重要文档。通过整理项目目标、技术栈、目录结构和约束规则,可以让 AI 快速建立项目模型,减少重复解释和错误修改。

学习目标

  • 掌握项目上下文说明应包含的核心信息。
  • 学会编写适合 AI 阅读的项目规则文档。
  • 能够验证上下文说明是否覆盖开发所需信息。

项目上下文说明的核心内容

一份有效的项目上下文说明不需要记录所有细节,而应该描述影响开发决策的信息。通常包括项目目标、技术栈、启动方式、目录职责和开发约束。

例如,一个 Web 项目需要让 AI 知道前端框架、后端服务、数据库类型、测试命令以及哪些文件属于核心模块。推荐结构如下:

内容 作用
项目目标 说明系统解决的问题
技术栈 限制实现方案
运行方式 说明启动和验证流程
目录结构 帮助定位代码职责
规则约束 防止产生不符合要求的修改

编写项目说明文件

可以在项目根目录创建上下文说明文件,例如 PROJECT_CONTEXT.md:

markdown
# 项目上下文

## 项目目标
构建一个用户管理服务。

## 技术栈
- Node.js
- TypeScript
- PostgreSQL

## 运行方式
安装依赖后执行 npm run dev。

## 代码规则
- 使用 async/await 处理异步逻辑。
- 新接口必须增加测试。
- 禁止直接修改数据库迁移历史。

文件内容应该保持稳定,频繁变化的任务需求不要写入长期上下文,否则会降低 AI 判断准确性。

在开发流程中使用上下文说明

使用 AI 修改项目时,可以先提供上下文说明,再提出具体任务。例如:

text
请先阅读 PROJECT_CONTEXT.md。
根据其中的技术约束,实现用户查询接口。
要求保持现有目录结构,并补充测试。

AI 获取项目背景后,会优先按照已有规则设计方案,而不是从零生成独立实现。

验证上下文是否有效

判断项目上下文是否合格,可以检查以下问题:

  • 新成员是否能根据文档启动项目。
  • AI 是否能理解主要模块职责。
  • 常见修改是否需要重复解释规则。
  • 文档中的约束是否仍然符合当前项目状态。

如果 AI 经常提出不符合项目方向的方案,通常说明上下文缺少关键约束,而不是模型能力不足。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

编写项目上下文说明

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通