使用AI助手进行Prompt工程的最佳实践

对于像Pieces这样的智能编程助手，聊天界面即是其主要用户界面。这种交互方式要求开发者掌握一套新的技能，通过自然语言与助手高效沟通。本文将结合实例，展示如何充分利用Pieces Copilot聊天功能的最佳实践。

---

## 代码生成与操作

代码生成是开发者使用大语言模型（LLM）的主要场景之一。LLM的训练数据基于大量代码库，其中部分模型（如Google的端侧模型Code Gemma，已集成到Pieces中）专门针对代码生成进行了优化。通过合理的提示词，开发者可以基于产品文档或开源项目中的现有代码生成新代码，或为现有代码库添加新功能。

### 明确说明预期结果（包括编程语言、库和框架）

LLM接受了多种编程语言的训练数据，因此在请求生成代码时，明确描述预期结果至关重要。这包括指定编程语言、使用的库或框架等。

- **避免模糊提问：**
  - 示例：生成一个函数。

- **建议清晰提问：**
  - 示例：请用Python编写一个函数，使用Pandas库读取CSV文件并计算平均值。

如果未明确指定语言，LLM通常会默认使用其训练集中占比最高的语言。例如，不指定语言时，生成的代码可能是Python；而对于Web相关项目，则更可能生成JavaScript代码。

此外，LLM还接受了大量库和框架的训练数据，因此在提示中明确说明所需的库或框架也非常重要。例如，指定使用React框架生成前端组件代码。

---

### 提供清晰的命名、结构及其他指导

为了获得更高质量的代码生成结果，可以在提示中提供详细的类名、字段名、结构定义及其他必要信息。例如：

- **不推荐：**
  - 创建一个用户模型类。

- **推荐：**
  - 使用C#创建一个包含Id、name和email属性的用户模型类，要求支持JSON序列化和相等比较。

通过一次性提供完整的细节，LLM可以生成更完整的代码块，而无需通过多次提示逐步生成。这种方法不仅高效，还能避免因多次提示导致的代码不一致或兼容性问题。

---

### 提供相关上下文

LLM在获得最大相关上下文且最少无关信息时表现最佳。为提高生成代码的准确性，建议根据需求提供相关的上下文信息。例如：

- **项目级上下文：** 如果需要处理整个项目，请添加项目所在文件夹作为上下文。
- **文件级上下文：** 如果只需处理单个文件，则仅添加该文件。

Pieces的相关性引擎会分析问题所需的上下文信息，并在上下文窗口限制内优先处理相关材料。对于大型项目（如包含数百万行代码），建议仅添加与问题相关的部分文件或文件夹。

在提示中引用上下文时，可以使用“本项目”统称，或直接引用具体的文件、类等组件名称。

---

### 遵循代码风格与格式指导

许多公司和开源项目都有特定的代码风格指南，例如Python的PEP8或内部规范。在生成代码时，可以通过以下方式要求LLM遵循特定风格规则：

- 在提示中明确说明风格要求。
- 添加格式文件（如.editorconfig）作为上下文。

例如，若需生成符合公司规范的C#代码，可在提示中附加.editorconfig文件，并要求LLM按照文件中的规则格式化代码。

---

## 长期记忆功能

Pieces通过捕获电脑活动上下文提供长期记忆功能，这是其独特优势之一。为充分利用该功能，需采用以下提示策略：

- **使用唯一标识符：** 在提示中使用名称、标题等唯一标识符。例如，提及特定对话时，可使用参与者姓名。
- **引用应用程序或窗口标题：** 如果需要Pieces使用特定应用的上下文，可通过名称引导关联引擎。例如，在VS Code中遇到运行错误时，可以明确要求“VS Code中的错误”，以避免获取其他无关错误的详情。
- **使用时间短语：** Pieces的长期记忆基于时间维度，支持通过“昨天”或“1小时前”等短语缩小范围。建议使用相对时间表述，而非具体日期，以避免误匹配。

---

## 提示优化与深层链接

Pieces支持通过提示获取访问过的网站深层链接。为提高准确性，提示中应包含以下信息：

- 站点概况。
- 唯一标识符（如站点名称）。
- 时间范围（如最近7天）。

通过提供这些细节，开发者可以快速定位相关资源并高效完成任务。

---

## 总结

通过合理的提示设计和上下文提供，开发者可以充分发挥Pieces Copilot的潜力，提升代码生成效率和质量。无论是明确预期结果、提供清晰结构，还是利用长期记忆功能，掌握这些最佳实践都能帮助开发者更高效地完成任务。

如需深入了解提示工程的理论与实践，建议参考我们的实用指南《LLM提示工程实战》。

原文链接: https://pieces.app/blog/10-prompt-engineering-best-practices