上下文工程模板

用于入门上下文工程的全面模板——这是一门为 AI 编码助手构建完整上下文的学科，使其拥有端到端完成任务所需的信息。

上下文工程比提示工程好 10 倍，比“凭感觉”编码好 100 倍。

🚀 快速开始

# 1. 克隆本模板
git clone https://github.com/coleam00/Context-Engineering-Intro.git
cd Context-Engineering-Intro

# 2. 设置项目规则（可选——已提供模板）
# 编辑 CLAUDE.md 添加项目特定的指导原则

# 3. 添加示例（强烈推荐）
# 将相关代码示例放入 examples/ 文件夹中

# 4. 创建初始功能需求
# 编辑 INITIAL.md 填写你的功能需求

# 5. 生成全面的产品需求提示（PRP）
# 在 Claude Code 中运行：
/generate-prp INITIAL.md

# 6. 执行 PRP 以实现你的功能
# 在 Claude Code 中运行：
/execute-prp PRPs/your-feature-name.md

📚 目录

• 什么是上下文工程？
• 模板结构
• 分步指南
• 编写有效的 INITIAL.md 文件
• PRP 工作流程
• 有效使用示例
• 最佳实践

什么是上下文工程？

上下文工程代表了对传统提示工程的一次范式转变：

提示工程 vs 上下文工程

提示工程：

• 专注于巧妙措辞和具体表达
• 仅限于如何表述任务
• 类似于给某人一张便签纸

上下文工程：

• 是一套完整的系统，用于提供全面的上下文
• 包括文档、示例、规则、模式和验证
• 类似于撰写一部包含所有细节的完整剧本

为什么上下文工程很重要？

1. 减少 AI 失败：大多数代理失败并非模型问题，而是上下文问题。
2. 确保一致性：AI 遵循你的项目模式和规范。
3. 支持复杂功能：在适当的上下文支持下，AI 可以处理多步骤实现。
4. 自我纠正：通过验证循环，AI 能够自行修复错误。

模板结构

context-engineering-intro/
├── .claude/
│   ├── commands/
│   │   ├── generate-prp.md    # 生成全面的 PRP
│   │   └── execute-prp.md     # 执行 PRP 以实现功能
│   └── settings.local.json    # Claude Code 的权限配置
├── PRPs/
│   ├── templates/
│   │   └── prp_base.md       # PRP 的基础模板
│   └── EXAMPLE_multi_agent_prp.md  # 完整 PRP 示例
├── examples/                  # 你的代码示例（至关重要！）
├── CLAUDE.md                 # AI 助手的全局规则
├── INITIAL.md               # 功能需求模板
├── INITIAL_EXAMPLE.md       # 功能需求示例
└── README.md                # 本文档

本模板不涉及 RAG 和工具相关的上下文工程，因为我很快会有更多相关内容推出。 ;)

分步指南

1. 设置全局规则（CLAUDE.md）

CLAUDE.md 文件包含了项目范围内的规则，AI 助手将在每次对话中遵循这些规则。模板中包括：

• 项目认知：阅读规划文档、检查任务
• 代码结构：文件大小限制、模块组织
• 测试要求：单元测试模式、覆盖率期望
• 风格规范：语言偏好、格式规则
• 文档标准：文档字符串格式、注释规范

你可以直接使用提供的模板，也可以根据你的项目进行自定义。

2. 创建初始功能需求

编辑 INITIAL.md 来描述你想要构建的内容：

## 功能：
[描述你想要构建的内容——明确功能和需求]

## 示例：
[列出 examples/ 文件夹中的任何示例文件，并说明它们应如何使用]

## 文档：
[附上相关文档、API 或 MCP 服务器资源的链接]

## 其他注意事项：
[提及任何需要注意的地方、特殊要求，或 AI 助手常会忽略的事项]

请参阅 INITIAL_EXAMPLE.md 获取完整示例。

3. 生成 PRP

PRP（产品需求提示）是包含以下内容的综合实现蓝图：

• 完整的上下文和文档
• 带有验证的实施步骤
• 错误处理模式
• 测试要求

它类似于 PRD（产品需求文档），但更专门地为指导 AI 编码助手而设计。

在 Claude Code 中运行：

/generate-prp INITIAL.md

注意： 斜杠命令是在 .claude/commands/ 中定义的自定义命令。你可以查看其实现方式：

• .claude/commands/generate-prp.md —— 查看它是如何研究并创建 PRP 的
• .claude/commands/execute-prp.md —— 查看它是如何根据 PRP 实现功能的

这些命令中的 $ARGUMENTS 变量会接收你在命令名称后传递的任何内容（例如 INITIAL.md 或 PRPs/your-feature.md）。

该命令将：

1. 读取你的功能需求
2. 研究代码库中的模式
3. 搜索相关文档
4. 在 PRPs/your-feature-name.md 中创建一个全面的 PRP。

4. 执行 PRP

PRP 生成后，执行它来实现你的功能：

/execute-prp PRPs/your-feature-name.md

AI 编码助手将：

1. 读取 PRP 中的所有上下文
2. 制定详细的实施计划
3. 按照计划逐步执行并进行验证
4. 运行测试并修复任何问题
5. 确保满足所有成功条件。

编写有效的 INITIAL.md 文件

关键部分解释

功能：要具体且全面

• ❌ “构建一个网页爬虫”
• ✅ “构建一个使用 BeautifulSoup 的异步网页爬虫，用于从电商网站提取商品数据、处理速率限制，并将结果存储到 PostgreSQL 数据库中”

示例：充分利用 examples/ 文件夹

• 将相关的代码模式放入 examples/ 文件夹
• 引用具体的文件和模式以供参考
• 解释需要模仿哪些方面

文档：包含所有相关资源

• API 文档 URL
• 库指南
• MCP 服务器文档
• 数据库模式

其他注意事项：捕捉重要细节

• 认证要求
• 速率限制或配额
• 常见陷阱
• 性能要求

PRP 工作流程

/generate-prp 的工作原理

该命令按照以下流程执行：

1. 研究阶段

   • 分析您的代码库中的模式
   • 搜索类似的实现方式
   • 识别需要遵循的编码规范

2. 文档收集

   • 获取相关的 API 文档
   • 包含库的文档
   • 补充常见的陷阱和细节

3. 蓝图创建

   • 创建分步的实现计划
   • 包括验证环节
   • 添加测试要求

4. 质量检查

   • 评估信心水平（1-10 分）
   • 确保所有上下文都被包含

/execute-prp 的工作原理

1. 加载上下文：读取完整的 PRP
2. 制定计划：使用 TodoWrite 创建详细的任务列表
3. 执行：逐项实现各个组件
4. 验证：运行测试和代码检查
5. 迭代：修复发现的问题
6. 完成：确保所有需求都已满足

完整生成示例请参阅 PRPs/EXAMPLE_multi_agent_prp.md。

有效使用示例

examples/ 文件夹对于成功至关重要。AI 编码助手在能够看到可遵循的模式时，表现会更好。

示例中应包含的内容

1. 代码结构模式

   • 模块的组织方式
   • 导入规范
   • 类和函数的模式

2. 测试模式

   • 测试文件的结构
   • 模拟方法
   • 断言风格

3. 集成模式

   • API 客户端的实现
   • 数据库连接
   • 认证流程

4. CLI 模式

   • 参数解析
   • 输出格式化
   • 错误处理

示例结构

examples/
├── README.md           # 解释每个示例所展示的内容
├── cli.py             # CLI 实现模式
├── agent/             # 代理架构模式
│   ├── agent.py      # 代理创建模式
│   ├── tools.py      # 工具实现模式
│   └── providers.py  # 多提供者模式
└── tests/            # 测试模式
    ├── test_agent.py # 单元测试模式
    └── conftest.py   # Pytest 配置

最佳实践

1. 在 INITIAL.md 中明确说明

• 不要假设 AI 了解您的偏好
• 包含具体的需求和限制条件
• 大量引用示例

2. 提供全面的示例

• 示例越多，实现效果越好
• 展示应该怎么做以及不应该怎么做
• 包括错误处理模式

3. 使用验证环节

• PRP 包含必须通过的测试命令
• AI 会不断迭代直到所有验证通过
• 这样可以确保第一次尝试就能得到可用的代码

4. 充分利用文档

• 包含官方 API 文档
• 添加 MCP 服务器资源
• 引用具体的文档章节

5. 自定义 CLAUDE.md

• 添加您的编码规范
• 包括项目特定的规则
• 定义编码标准

资源

• Claude 代码文档
• 上下文工程最佳实践

Context Engineering Intro 快速上手指南

本指南帮助中国开发者快速掌握 Context Engineering（上下文工程）模板，通过构建完善的上下文体系，让 AI 编程助手（如 Claude Code）能够端到端地高质量完成开发任务。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows (WSL2 推荐)
• 核心工具:
  • Git (已安装并配置好)
  • Claude Code (必须安装并登录，这是执行模板命令的核心运行时)
• 前置依赖:
  • 无需额外的 Python 或 Node.js 依赖包，本模板主要依靠配置文件和 Markdown 文档驱动 AI 行为。
  • 确保你的项目目录具有读写权限。

注意: 本工具专为 Claude Code 设计，利用其自定义命令功能（Slash Commands）。如果你使用其他 AI 终端工具，可能需要手动复制 .claude/commands/ 中的逻辑。

安装步骤

只需简单的克隆操作即可获取模板：

# 1. 克隆模板仓库
git clone https://github.com/coleam00/Context-Engineering-Intro.git
cd Context-Engineering-Intro

# 2. (可选) 将模板集成到你现有的项目中
# 你可以将 .claude/, CLAUDE.md, INITIAL.md 等文件复制到你的项目根目录

基本使用

以下是使用该模板实现一个功能的最简工作流：

第一步：配置全局规则 (可选但推荐)

编辑 CLAUDE.md 文件，定义你项目的代码风格、测试要求和目录结构规范。如果直接使用模板，可跳过此步或使用默认配置。

第二步：编写需求文档

编辑 INITIAL.md 文件，清晰描述你要构建的功能。请参考以下结构：

## FEATURE:
[详细描述功能，例如：构建一个异步网页爬虫，使用 BeautifulSoup 提取数据并存入 PostgreSQL]

## EXAMPLES:
[列出 examples/ 文件夹中供 AI 参考的代码示例文件]

## DOCUMENTATION:
[相关 API 文档链接或 MCP 服务器资源]

## OTHER CONSIDERATIONS:
[注意事项，如认证要求、速率限制或常见陷阱]

第三步：生成产品需求提示 (PRP)

在终端中运行以下命令，AI 将分析你的需求并生成一份包含完整上下文、实施步骤和验证标准的蓝图：

/generate-prp INITIAL.md

执行后，系统会在 PRPs/ 目录下生成一个名为 your-feature-name.md 的详细文件。

第四步：执行实施

运行生成的 PRP 文件，让 AI 自动执行编码、测试和修复循环：

/execute-prp PRPs/your-feature-name.md

执行过程说明：

1. AI 读取 PRP 中的所有上下文。
2. 创建详细的任务列表 (TodoWrite)。
3. 逐步编写代码并运行测试。
4. 自动修复报错，直到所有验证通过。

---

💡 核心提示: 为了获得最佳效果，请务必在 examples/ 文件夹中放入你现有的优质代码片段。AI 通过模仿这些示例，能更准确地遵循你的项目模式。