RAG知识库代码生成调试清晰框架提示词

角色定义与任务定位

请以“RAG系统架构师与代码质量工程师”的身份，运用此提示词框架。你的核心目标是：为基于特定知识库（RAG）的代码生成任务，构建一个从需求理解、代码实现到调试验证的完整、清晰、可复现的工作流。你需要确保生成的代码不仅功能正确，更能与知识库上下文深度契合，逻辑清晰，便于后续维护与迭代。

适用场景

• 根据技术文档或API知识库，自动生成数据查询、处理或集成代码片段。
• 为已有的RAG检索结果，编写对应的结果解析、格式化或应用逻辑代码。
• 针对知识库内容，生成单元测试用例或调试验证脚本。
• 构建代码生成与调试的标准化提示词模板，用于团队协作或自动化流程。

核心提示词

可直接复制使用的提示词结构：

• 生成阶段：“基于以下知识库上下文：[此处粘贴相关上下文]。请以[编程语言]编写一个函数/模块，实现[具体功能描述]。要求代码包含清晰的注释，并说明关键步骤如何与上下文中的[特定概念/API]关联。”
• 调试与验证阶段：“分析以下基于知识库生成的代码：[粘贴代码]。请结合知识库上下文：[粘贴上下文]，逐步检查其逻辑一致性、对上下文信息的利用率以及潜在边界条件。给出具体的修改建议与优化后的代码片段。”
• 流程整合提示：“请遵循‘检索-理解-生成-验证’框架。首先，从知识库中检索与‘[任务关键词]’最相关的内容。其次，解释这些内容如何影响代码设计。然后，生成实现代码。最后，提出两个用于验证代码是否准确反映知识库内容的测试点。”

风格方向

• 代码风格：工业级、模块化、注释详尽。强调可读性与符合知识库中引用的规范。
• 文档风格：技术报告式、步骤清晰、逻辑链完整。视觉上可采用代码块与说明文字交替呈现的版面。
• 思维风格：结构化思维、溯源思维（将代码逻辑明确关联回知识源）、防御性编程思维。

构图建议

• 若进行视觉化呈现，建议采用“左文右码”或“上流程下图谱”的布局，清晰区隔知识上下文、生成代码与调试注释。
• 使用流程图元素可视化“需求输入 -> 知识检索 -> 代码生成 -> 测试验证”的完整闭环。
• 重点突出代码与知识库条目之间的引用连线或高亮标记，体现“可追溯性”。

细节强化

• 关键词锚定：在提示词中强制包含知识库中的特定术语、API名称或数据模型字段，确保生成准确性。
• 边界条件：明确要求代码处理知识库中提到的异常情况或数据边界。
• 性能提示：加入对时间/空间复杂度的考量，特别是当知识库上下文涉及大规模数据处理时。
• 色彩/氛围暗示：在描述整体框架时，可使用“清晰、冷静、有条理的蓝灰色调”或“高对比度的代码高亮色”来隐喻专业与精准。

使用建议

• 将“核心提示词”作为模板，在实际使用时替换方括号内的具体内容。
• 建议分步骤使用：先运行“生成阶段”提示词，获得代码后，再将其作为输入，运行“调试与验证阶段”提示词，形成迭代。
• “流程整合提示”适用于需要一次性获得完整思考链路的场景，对提示词工程经验要求较高。
• 可根据具体知识库类型（如API文档、故障解决方案库、产品规格书），调整提示词中对于“关联方式”的描述（例如：“调用”、“遵循”、“实例化”、“规避”）。