RAG知识库代码重构建议专业版提示词
这是一份面向技术架构师与高级开发者的专业提示词方案,旨在将“RAG知识库代码重构建议”这一需...
提示词内容
复制角色定义与任务定位
请以“资深软件架构师”或“代码重构专项顾问”的身份,运用你的系统设计经验与代码质量洞察力,对现有RAG(检索增强生成)知识库系统的代码进行深度评估与重构规划。你的核心目标是:生成一份专业、结构化、可执行的重构建议报告,旨在提升系统的可维护性、性能、可扩展性,并清晰识别与规避潜在的技术债务。
适用场景
- 对现有RAG项目进行技术债务审计与代码质量评估。
- 在项目迭代或性能瓶颈期,规划系统性的代码重构方案。
- 为新团队成员提供清晰的核心模块架构与代码规范指引。
- 为技术决策者(CTO、技术总监)撰写重构必要性分析与实施路线图。
核心提示词
以下提示词组合可直接用于引导AI生成或作为你撰写报告的大纲:
- “作为资深软件架构师,请对以下RAG知识库的[代码片段/模块描述]进行重构分析。请首先评估其当前在模块耦合度、错误处理完备性、向量检索效率、提示词管理方面的现状与问题。”
- “生成一份专业的RAG代码重构建议报告,需包含:重构目标优先级排序、关键模块重构方案(如文档加载器、文本分割器、向量化索引、检索链)、具体的代码结构优化建议、性能提升指标预期。”
- “针对RAG系统中常见的‘上下文窗口管理混乱’和‘检索结果后处理薄弱’问题,提出结构化的代码重构策略与可落地的类/函数设计改进示例。”
风格方向
- 文体风格:采用技术方案报告或架构设计文档的风格,语言精准、客观、结构化,避免口语化。
- 专业基调:体现严谨性与前瞻性,平衡技术理想与落地成本,使用标准的软件工程术语(如SOLID原则、关注点分离、依赖注入等)。
- 视觉隐喻:在描述架构时,可借用“分层清晰”、“管道流畅”、“模块化积木”、“去冗余瘦身”等视觉化比喻,增强理解。
构图建议(报告结构)
- 顶层框架:采用“现状诊断 -> 重构目标 -> 详细方案 -> 实施步骤 -> 风险与回滚”的逻辑流构建报告主体。
- 重点突出:使用分级标题(H1, H2, H3)明确结构;关键建议、代码坏味道示例、优化后的伪代码片段应单独列出或高亮。
- 对比呈现:在关键优化点(如检索流程),采用“重构前流程”与“重构后流程”的对比图表或列表进行说明,直观展示改进。
细节强化
- 代码级细节:具体指出哪些函数过长、哪些类职责过重、哪些配置应外置。例如:“将硬编码的提示词模板抽取至独立的YAML配置文件或提示词管理类中。”
- 性能指标:关联具体的可衡量指标,如“通过重构检索链,目标是将平均检索延迟从Xms降低至Yms”或“减少Z%的重复计算”。
- 工具与规范:推荐配套的静态分析工具(如SonarQube)、代码格式化标准,并建议引入针对RAG组件的单元测试与集成测试模式。
- 扩展性考量:强调如何通过重构使系统更容易支持新的嵌入模型、向量数据库或检索排序算法。
使用建议
- 将上述“核心提示词”直接输入至具备代码分析能力的AI助手(如Claude、ChatGPT等),以生成初步的重构分析草稿。
- 在“核心提示词”中替换方括号[]内的具体内容(如你的模块名称、代码文件),以获得更具针对性的建议。
- 生成的报告可作为技术会议讨论蓝本,或拆解为具体的开发任务卡(Task Card)纳入迭代计划。
- 本方案侧重于“建议”生成,实际重构前务必结合完整的代码审查与测试。