跳到主要内容

开发智能体

本目录包含专门为井云服务中心项目定制的 AI 开发辅助提示词,帮助 AI 工具生成符合项目规范的高质量代码。这些提示词经过精心设计,确保输出的代码符合微服务架构、测试规范和编码标准。

📁 目录结构

ai-prompts/
├── README.md # 本文件
├── ai_wire_prompt.md # Wire 依赖注入生成提示词
├── ai_testing_prompt.md # 测试代码生成提示词
├── ai_git_prompt.md # Git 操作辅助提示词
├── ai_code_review_prompt.md # 代码审查专家提示词
├── ai_refactoring_prompt.md # 功能重构专家提示词
├── ai_api_design_prompt.md # 新接口实现专家提示词
├── ai_bug_fix_prompt.md # Bug修复专家提示词
├── ai_architecture_review_prompt.md # 架构与技术方案评审专家提示词
├── ai_prompt_prompt.md # 提示词生成规范
└── [其他提示词文件] # 未来可能添加的其他提示词

🤖 开发智能体说明

1. Wire 依赖注入 (ai_wire_prompt.md)

  • 用途: 自动生成 Wire 依赖注入代码
  • 核心特性:
    • 强约束规则,确保代码符合项目架构
    • 支持 ProviderSet 分层组织
    • 一次性生成可编译、可维护的代码
  • 适用场景: 新服务 Wire 配置、现有服务依赖注入修改

2. 测试代码生成 (ai_testing_prompt.md)

  • 用途: 自动生成高质量的测试代码
  • 核心特性:
    • 严格遵循项目测试规范(90%+ 覆盖率)
    • 支持 Gateway 和数据库服务的差异化测试
    • 完整的 Mock 策略和错误场景覆盖
  • 适用场景: 单元测试、集成测试、端到端测试生成

3. Git 操作辅助 (ai_git_prompt.md)

  • 用途: Git 工作流和代码审查辅助
  • 核心特性:
    • 智能提交信息生成(Conventional Commits)
    • 自动化代码审查和问题诊断
    • 性能分析和安全审查支持
  • 适用场景: 日常 Git 操作、PR 审查、问题排查

4. 代码审查专家 (ai_code_review_prompt.md)

  • 用途: 专业的代码审查和质量保证
  • 核心特性:
    • 重点关注配置变更和生产可靠性
    • 魔数检测和影响评估
    • 生产安全优先的审查原则
  • 适用场景: 代码审查、配置变更审核、生产安全检查

5. 功能重构专家 (ai_refactoring_prompt.md)

  • 用途: 专业的功能重构和架构优化
  • 核心特性:
    • 代码异味识别和架构分析
    • 渐进式重构方案设计
    • 风险评估和测试驱动重构
  • 适用场景: 代码质量改进、架构优化、技术债务清理

6. 新接口实现专家 (ai_api_design_prompt.md)

  • 用途: 专门用于新接口设计与功能实现
  • 核心特性:
    • 需求理解优先,结构清晰语义明确
    • 工程可落地,稳定与可演进
    • 完整的接口设计规范和输出要求
  • 适用场景: 新API接口设计、功能扩展设计、接口规范制定

7. Bug修复专家 (ai_bug_fix_prompt.md)

  • 用途: 专门用于Bug分析和修复
  • 核心特性:
    • 快速定位问题根因
    • 安全可靠的修复方案
    • 完整的测试验证和预防措施
  • 适用场景: 系统Bug修复、性能问题优化、异常处理改进

8. 架构与技术方案评审专家 (ai_architecture_review_prompt.md)

  • 用途: 专业的架构与技术方案评审
  • 核心特性:
    • 以评审者而非实现者的视角进行分析
    • 阻止不必要的复杂度进入系统
    • 严格的工程现实感和风险意识
    • 明确的评审结论和否决权
  • 适用场景: 架构设计评审、技术选型决策、重大改动评估

9. 提示词生成规范 (ai_prompt_prompt.md)

  • 用途: 专门用于生成项目AI提示词文档的规范模板
  • 核心特性:
    • 标准化的提示词文档结构
    • 强制约束和格式规范
    • 内容去重复和质量保证
  • 适用场景: 创建新的AI提示词文档、提示词规范管理

📋 使用指南

给 AI 使用提示词时

  1. 选择合适的提示词文件:

    • 需要生成 Wire 代码 → 使用 ai_wire_prompt.md
    • 需要生成测试代码 → 使用 ai_testing_prompt.md
    • 需要 Git 操作辅助 → 使用 ai_git_prompt.md
    • 需要代码审查 → 使用 ai_code_review_prompt.md
    • 需要功能重构 → 使用 ai_refactoring_prompt.md
    • 需要新接口设计 → 使用 ai_api_design_prompt.md
    • 需要 Bug 修复 → 使用 ai_bug_fix_prompt.md
    • 需要架构评审 → 使用 ai_architecture_review_prompt.md
    • 需要创建新提示词 → 使用 ai_prompt_prompt.md
  2. 提供完整的上下文:

    • 包含相关的代码结构
    • 说明具体的需求
    • 提供必要的接口定义
  3. 遵循提示词中的约束:

    • 不要修改提示词的核心规则
    • 按照指定的格式提供输入
    • 确保输出符合项目规范

维护提示词

当项目有重大变更时,需要相应更新提示词:

  1. 架构变更: 更新 Wire 提示词中的模式
  2. 测试规范更新: 更新测试提示词中的要求
  3. 新增功能: 添加新的提示词文件

🔗 相关文档

📝 贡献指南

如需添加新的提示词文件:

  1. 创建新的 .md 文件
  2. 遵循现有的命名规范 ai_<功能>_prompt.md
  3. 包含清晰的用途说明和使用指南
  4. 更新本 README.md 文件

注意: 这些提示词是项目的重要资产,请谨慎修改,确保任何变更都经过充分测试。