datai/docs/archive/prompts/009-metadata-retrieve-deploy.md

76 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Prompt First 模板
## 输入引用
引用相关的 docs 文档链接:
- [需求文档](../requirements/REQ-009.md) - 元数据拉取和部署功能实现
- [架构决策](../decisions/adr/0009-metadata-retrieve-deploy.md) - 元数据拉取和部署功能架构决策
## Context Maps
强制列出本次 Prompt 依赖的 Canvas 文件:
- [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示
## 目标
明确描述此提示词的目标和预期效果:
1. 实现 Salesforce 元数据拉取功能,支持根据 package.xml 拉取指定元数据
2. 实现 Salesforce 元数据部署功能,支持全量/增量部署、验证、单元测试和破坏性变更
3. 实现异步处理机制,不阻塞请求线程
4. 实现详细的部署结果解析和错误信息记录
5. 支持使用验证 ID 进行快速部署
## 输出格式
指定期望的输出格式:
- 代码示例语言Java
- 文档结构Markdown
## 约束
列出使用此提示词时的约束条件:
- 技术栈限制Java 17/21, Spring Boot 3.x, Salesforce Metadata API, OAuth 2.0
- 必须遵循分层架构Controller 层 -> Service 层 -> Salesforce API 层
- 必须实现异步处理机制
- 必须实现详细的错误处理和日志记录
- 必须支持 Salesforce API 调用限制处理
## Rule Set
"请严格参考元数据拉取和部署的架构决策文档,不要自行发挥。"
**具体规则**
- 必须使用架构决策中定义的数据库表结构
- 必须遵循架构决策中定义的异步处理模式
- 必须实现架构决策中定义的核心功能
- 必须遵循项目的代码风格和命名规范
## 验收标准
定义验证输出质量的具体标准:
1. 功能完整性:实现所有需求文档中定义的功能
2. 代码正确性:代码能够正常编译和运行,无语法错误
3. 性能指标:异步处理不阻塞请求线程,支持并发处理
4. 安全性要求:所有 Salesforce 认证信息必须加密存储
5. 可靠性要求:系统能够处理 API 调用失败和重试
## 风险
识别使用此提示词可能带来的风险:
- 输出质量风险:代码可能存在逻辑错误或性能问题
- 技术实现风险Salesforce API 调用可能遇到限制或兼容性问题
- 时间成本风险:实现复杂功能可能需要较长时间
- 测试风险:需要大量测试用例验证功能正确性
## 使用记录
| 日期 | 使用场景 | 输入参数 | 输出结果 | 反馈 | 改进措施 |
|------|---------|---------|---------|------|----------|
| 2026-01-17 | 元数据拉取和部署功能实现 | 需求文档、架构决策 | Java 代码和相关文档 | 待反馈 | 待改进 |