今天，我想和大家分享關于 AI 提示詞工程的文章。提示詞（Prompt）是大型語言模型（LLM）生成高質量輸出的關鍵，而在像 MetaGPT 這樣的 AI 驅動軟件開發框架中，提示詞的設計直接決定了代碼生成的可靠性和效率。本文基于 MetaGPT 框架中的 write_code.py 文件，詳細剖析其提示詞模板、設計分析、任務流程以及值得借鑒的經驗。如果你對 AI 代理、代碼生成或提示詞優化感興趣，這篇文章將為你提供寶貴的洞見。

MetaGPT 框架簡介

MetaGPT 是一個創新的 AI 框架，旨在通過多代理協作模擬軟件開發過程。其中，WriteCode 是核心動作之一，它負責為單個文件生成代碼。這個動作不是簡單地“寫代碼”，而是通過精心設計的提示詞來指導 LLM 產生符合谷歌風格的、模塊化且易維護的代碼。讓我們先來看看這個提示詞模板（PROMPT_TEMPLATE）的內容。

提示詞模板詳解

以下是 write_code.py 中定義的 PROMPT_TEMPLATE。它是一套給 LLM 的詳細指令，結構清晰、約束嚴格：

text

注意

角色：你是一名專業的工程師；主要目標是編寫谷歌風格、優雅、模塊化、易于閱讀和維護的代碼。

語言：請使用與用戶需求相同的語言，但標題和代碼仍應為英文。例如，如果用戶說中文，你回答的具體文本也應該是中文。

注意：使用 '##' 來分割章節，而不是 '#'。請仔細參考“格式示例”來確定輸出格式。

# 上下文

## 設計

{design}

## 任務

{task}

## 已有代碼

{code}

## 調試日志

```text

{logs}

{summary_log}

Bug反饋日志

{feedback}

格式示例

代碼: {demo_filename}.py

Python

## {demo_filename}.py

...

代碼: {demo_filename}.js

JavaScript

// {demo_filename}.js

...

指令：根據上下文，遵循“格式示例”編寫代碼。

代碼：{filename}。請根據以下注意事項和上下文，使用三引號編寫代碼。

1. 僅限單個文件：盡你所能，只實現這一個文件。

2. 完整的代碼：你的代碼將成為整個項目的一部分，因此請實現完整、可靠、可復用的代碼片段。

3. 設置默認值：如果存在任何設置項，務必設置一個默認值，始終使用強類型和顯式變量。避免循環導入。

4. 遵循設計：你必須遵循“數據結構和接口”部分的設計。不要更改任何設計。不要使用設計中不存在的公共成員函數。

5. 仔細檢查：確保你沒有遺漏此文件中任何必要的類/函數。

6. 先導入再使用：在使用外部變量/模塊之前，請確保你已經導入了它。

7. 寫出所有細節：寫出每一個代碼細節，不要留下任何 TODO（待辦事項）。

這個模板以角色扮演開頭，注入結構化的上下文（如設計、任務、已有代碼和日志），并提供格式示例和嚴格指令。它的設計確保 LLM 輸出的是可解析的、高質量代碼。

提示詞設計分析

這個提示詞是針對代碼生成這類復雜任務進行高級提示詞工程的絕佳范例。讓我們逐一拆解其亮點：

1. 明確的角色扮演 (Clear Role-Playing)
   • 好處：提示詞以“角色：你是一名專業的工程師”開場，這立即為模型設定了場景。它指示 LLM 采納專家的角色，從而影響其輸出的語氣、風格以及對最佳實踐（如編寫“谷歌風格、優雅、模塊化”代碼）的遵循程度。
2. 結構化的上下文注入 (Structured Context Injection)
   • 好處：提示詞定義了清晰的章節（## 設計、## 任務、## 已有代碼、## 調試日志），用于動態插入特定信息。這比將所有信息堆在一個大塊里要有效得多。LLM 可以輕松地區分高層設計、具體任務、現有代碼和錯誤日志，從而產出更具上下文感知能力、更準確的代碼。
3. 格式示例驅動 (Format Example Driven)
   • 好處：“# 格式示例”部分提供了一個具體、可視化的期望輸出模板。這是一種“少樣本”或“單樣本”學習的形式，極大地約束了 LLM 的輸出格式。它強制模型生成一個干凈、可預測且機器可解析的 Markdown 代碼塊，這對后續的 CodeParser 可靠工作至關重要。
4. 極其具體的指令和約束 (Hyper-Specific Instructions and Constraints)
   • 好處：最后的“# 指令”部分列出了七條非常具體的規則。這些規則解決了 LLM 在代碼生成任務中常見的失敗模式：
     • “僅限單個文件”：防止模型一次性嘗試創建多個文件。
     • “完整的代碼”、“不要留下任何 TODO”：阻止模型生成占位符或不完整的代碼。
     • “遵循設計”、“不要更改任何設計”：強制模型嚴格遵守提供的軟件設計，防止其偏離軌道或“幻覺出”新的功能。
   • 這些精確的約束極大地提高了生成代碼的可靠性和實用性。

通過這些元素，這個提示詞不僅僅是“告訴” LLM 做什么，還“指導”它如何做，確保輸出的一致性和高質量。

整體代碼任務與借鑒之處

任務講解 (Task Explanation)

WriteCode Python 類是 MetaGPT 框架中的一個AI 動作（AI Action）。它唯一的工作就是為單個文件編寫代碼。

為了完成這個任務，它的 run 方法扮演了一個上下文聚合器的角色：

1. 加載上下文：它從項目倉庫（ProjectRepo）中讀取大量文檔，包括高層需求、當前文件的特定軟件設計（design_doc）、任務描述（task_doc）、其他文件中的現有代碼（Legacy Code），以及先前失敗運行的日志（Debug logs、Bug Feedback logs）。
2. 收集相關代碼：它使用 get_codes 靜態方法來獲取項目中其他相關源文件的內容。這至關重要，能讓 LLM 知道它可能需要與之交互的其他類和函數。
3. 構建提示詞：它將所有聚合來的上下文，一絲不茍地填充到 PROMPT_TEMPLATE 中。
4. 執行并解析：它用構建好的完整提示詞調用 LLM（并使用重試機制以保證健壯性）。然后，它使用一個 CodeParser 從 LLM 的響應中僅提取代碼部分，丟棄任何對話性文本。
5. 返回結構化輸出：最后，它將干凈的代碼放入一個 CodingContext 對象中，準備好被保存到文件或被代理工作流中的下一個動作（如 RunCode 或 DebugError 動作）使用。

這個流程展示了如何將提示詞與實際代碼執行無縫結合，形成一個高效的 AI 驅動開發管道。

值得借鑒之處 (What to Learn From It)

這段代碼是構建健壯、面向任務的 AI 代理的絕佳藍圖。以下是幾點關鍵經驗：

1. 上下文為王 (Context is King)：最重要的經驗是系統化地聚合豐富的上下文。不要只是簡單地要求 LLM “寫一個用戶登錄文件”，而是要為它提供 API 設計、數據結構、相關代碼和錯誤歷史。這會極大地提升產出質量。
2. 自動化彈性 (Automated Resiliency)：在 write_code 方法上使用 @retry 裝飾器是一個簡單但強大的技術。對 LLM API 的網絡調用可能不穩定；通過指數退避策略進行自動重試，能讓整個系統變得更加穩定。
3. 模塊化的動作 (Modularity with Actions)：將邏輯封裝到不同的 Action 類中（WriteCode 就是其中之一）是優秀的軟件設計。它使系統更易于理解、維護和擴展。每個動作都有單一、清晰的職責。
4. 解析，而非假設 (Parse, Don't Assume)：永遠不要完全相信 LLM 的輸出格式。務必有一個解析器（如 CodeParser）來凈化輸出，并精確提取你需要的部分。這將“生成”步驟與“處理”步驟解耦。
5. 配置驅動邏輯 (Configuration-Driven Logic)：代碼通過檢查 self.config.inc 來判斷是處于初始創建模式還是“增量”（修改）模式。這使得同一個 Action 可以在軟件開發生命周期的不同階段被復用，使其具有高度的靈活性。

作者自言自語：

分享了那么多提示詞的技巧給大家，在分享的同時自己也在思考提示詞的意義是什么。我想在AI快速發展的今天，大模型會成為我們必不可少的助手，但是如何和這個助手產生更深的連接🔗，如何讓助手最大限度的發揮自己的作用，讓我們能從反復的工作抽離出來，去探究事情的本質，去感受生活的奧秘，我覺得是當前我們學習提示詞，學習如何和大模型說話的意義。

結語

在 AI 時代，提示詞工程不再是可選項，而是構建可靠系統的核心。通過 MetaGPT 的 WriteCode 示例，我們看到一個精心設計的提示詞如何驅動復雜的代碼生成任務。如果你正在開發自己的 AI 代理或優化 LLM 應用，不妨借鑒這些技巧：角色扮演、結構化上下文、格式示例和嚴格約束。歡迎在評論區分享你的經驗，或者告訴我你對下一個 MetaGPT 組件的分析感興趣！

如果這篇文章對你有幫助，請點贊和分享。謝謝閱讀！ 🚀