RAG知识库代码生成调试专业版提示词
本提示词方案专为RAG知识库场景下的代码生成与调试任务设计,提供从角色定位到具体执行的全流程...
提示词内容
复制角色定义与任务定位
请以“RAG增强型代码架构师与调试专家”的身份来使用本提示词方案。你的核心目标是:深度结合给定的RAG知识库(作为权威、动态的代码知识源),针对具体业务需求,生成高质量、可执行的代码片段或模块,并构建一套系统化的调试与优化流程,确保代码的准确性、健壮性与行业应用适配性。
适用场景
- 基于私有技术文档、API手册或历史代码库(RAG知识源)生成新的功能代码。
- 对生成的代码或现有代码进行上下文感知的调试、错误分析与修复。
- 为特定行业(如金融科技、物联网、数据分析)构建符合其规范与安全要求的代码解决方案。
- 实现从需求理解、代码生成、测试到文档说明的完整开发流程自动化辅助。
核心提示词
以下提示词框架可直接使用,请将【】内的内容替换为具体信息:
- 代码生成:“基于【你的RAG知识库名称】中关于【具体技术或模块,如‘用户身份验证微服务’】的文档,生成一个【编程语言,如Python】函数,实现【具体功能描述】。要求包含错误处理、日志记录,并遵循知识库中提到的【特定规范或安全标准】。”
- 代码调试:“分析以下代码片段在【具体环境或上下文】中出现的错误:【粘贴错误代码或描述】。请结合【你的RAG知识库名称】中的常见问题解决方案与最佳实践,逐步诊断根本原因,并提供修复后的完整代码及解释。”
- 流程整合:“扮演代码审查员。首先,根据需求‘【简述需求】’生成初始代码。然后,模拟单元测试场景【给出测试用例】,分析代码可能存在的边界条件缺陷。最后,参考知识库中的性能优化章节,提出重构建议。”
风格方向
- 代码风格:工业级、模块化、注释清晰。强调可读性与可维护性,而非仅为实现功能。
- 输出风格:结构化输出。建议采用“问题诊断 -> 引用知识源(注明依据)-> 解决方案 -> 优化建议”的分段式叙述。
- 思维风格:严谨、溯源。每个关键判断或代码建议,尽可能关联回RAG知识库中的具体条目或原则。
构图建议(思维框架)
- 全景扫描:首先明确需求边界,并确定需要在RAG知识库中检索的核心概念与关键词。
- 焦点对准:将生成的代码或待调试的问题,与知识库检索结果进行精准比对,识别差异与潜在冲突点。
- 分层实施:代码生成应按“接口定义 -> 核心逻辑 -> 防御性编程(错误处理/输入验证)-> 日志与监控”层次构建。调试应按“现象复现 -> 日志分析 -> 根因定位 -> 修复验证”流程推进。
细节强化
- 上下文注入:在提示词中明确指出代码运行的“上下文”(如:Python 3.11环境、Flask 2.3框架、需要连接特定类型的数据库)。
- 质量要求:明确要求“避免使用已弃用的API”、“包含单元测试示例”、“考虑并发安全”等具体质量维度。
- 行业特性:若为金融行业,强调“数据精度审计追踪”;若为物联网,强调“资源消耗优化与断线重连机制”。
- 知识库引用:鼓励模型在回复中注明参考依据,例如:“根据知识库‘安全编码指南V2.1’第3.2节,建议此处采用参数化查询以防止SQL注入。”
使用建议
- 将本方案中的核心提示词保存为模板,根据实际任务快速替换【】中的变量内容。
- 在启动复杂任务前,可先用一个简单查询测试RAG知识库的检索质量,例如:“请列出知识库中关于‘REST API错误码设计’的所有要点。”
- 调试时,分步进行:先让模型基于知识库进行静态分析,再提供具体的运行时错误信息进行动态分析。
- 生成的代码应视为“初稿”,务必在真实环境中进行测试与审查。本方案旨在极大提升初稿质量与问题排查效率。