24 KiB
24 KiB
单一真源文档中心
项目概述
本文件是 Salesforce 集成项目的单一真源入口，包含所有项目相关文档的链接清单。
文档目录
【视觉看板】
- 架构图: Authentication.canvas - 项目架构视觉化展示，包含认证、集成、通用和配置模块的详细结构
1. 需求文档
- 目录: requirements/
- 描述: 包含项目的功能需求、非功能需求和验收标准
- 需求文档:
- PartnerAPI源org实现 - 进行中（子需求 001-01 已完成，001-02 已完成，001-03 已完成，001-04 已完成，001-05 已完成，001-06 已完成阶段 8） - 高
- ApexAPI源org实现 - 进行中 - 高
- MetadataAPI源org实现 - 进行中 - 高
- ToolingAPI源org实现 - 进行中 - 高
- Apex模块代码存储重构 - 进行中 - 高
2. 设计文档
- 目录: design/
- 描述: 包含系统架构设计、模块设计和接口设计
- 设计文档:
- 认证和会话管理-设计 - 已完成（代码已实现）
- CRUD操作-设计 - 已完成（代码已实现）
- 批量操作-设计 - 已完成（代码已实现）
- 查询功能-设计 - 已完成（代码已实现）
- 描述功能-设计 - 已完成（代码已实现）
- 高级功能-设计 - 已完成（代码已实现）
- Apex连接管理-设计 - 已完成（代码已实现）
- Metadata连接管理-设计 - 已完成（代码已实现）
- 元数据类型定义-设计 - 已完成
- 部署操作-设计 - 进行中
- Apex代码编译和执行-设计 - 已完成（代码已实现）
- Apex代码编译和执行-变更日志 - 已完成
- 测试执行-设计 - 已完成（代码已实现）
- 代码覆盖率-设计 - 已完成（代码已实现）
- Flow覆盖率-设计 - 进行中
- 日志记录-设计 - 进行中
- WSDL转换-设计 - 进行中
- 异步操作-设计 - 进行中
- 删除操作-设计 - 进行中
- 连接管理-设计 - 已完成（代码已实现）
- 元数据操作-设计 - 进行中（Tooling API 元数据操作）
- 开发工具功能-设计 - 进行中（Tooling API 开发工具功能）
- AI和智能功能-设计 - 进行中（Tooling API AI和智能功能）
- 动作和自动化功能-设计 - 进行中（Tooling API 动作和自动化功能）
- 访问和安全功能-设计 - 已完成（Tooling API 访问和安全功能）
- 高级功能-设计 - 已完成（Tooling API 高级功能）
- SOQL查询功能-设计 - 已完成（Tooling API SOQL查询功能）
3. 提示词 (Prompt)
- 目录: prompts/
- 描述: 包含各需求的专用代码生成提示词
- 提示词文档:
- Metadata连接管理提示词 - Metadata连接管理的执行提示词
- Apex代码编译和执行提示词 - Apex代码编译和执行的执行提示词
3. 架构决策
- 目录: decisions/
- 描述: 包含架构决策记录 (ADR)，记录重要的架构决策过程
- ADR文档:
- 认证和会话管理技术选型 - 已接受
- 连接管理技术选型 - 已接受（Tooling API 连接管理）
- 元数据操作技术选型 - 已接受（Tooling API 元数据操作）
- 开发工具功能技术选型 - 已接受（Tooling API 开发工具功能）
- AI和智能功能技术选型 - 已接受（Tooling API AI和智能功能）
- 动作和自动化功能技术选型 - 已接受（Tooling API 动作和自动化功能）
- 访问和安全功能技术选型 - 已接受（Tooling API 访问和安全功能）
- 高级功能技术选型 - 已接受（Tooling API 高级功能）
- SOQL查询功能技术选型 - 已接受（Tooling API SOQL查询功能）
- CRUD操作技术选型 - 已接受
- 批量操作技术选型 - 已接受
- 查询功能技术选型 - 已接受
- 描述功能技术选型 - 已接受
- 高级功能技术选型 - 已接受
- Apex连接管理技术选型 - 已接受
- Metadata连接管理技术选型 - 已接受
- Apex代码编译和执行技术选型 - 已接受
- 测试执行技术选型 - 已接受
- 代码覆盖率技术选型 - 已接受
- Flow覆盖率技术选型 - 已接受
- 元数据部署技术选型 - 已接受
- 通用部署接口设计 - 已接受
- 异步操作轮询策略 - 已接受
- 删除操作技术选型 - 已接受
- 检索操作技术选型 - 已接受
- 检查部署和检索状态技术选型 - 已接受
- 描述和列出元数据技术选型 - 已接受
- WSDL转换技术选型 - 已接受
4. 提示词库
- 目录: prompts/
- 描述: 包含 AI 提示词模板和最佳实践
- 模板: 0000-template.md
- 提示词文件:
- 认证和会话管理提示词 - 认证和会话管理的执行提示词
- 连接管理提示词 - Tooling API 连接管理的执行提示词
- 元数据操作提示词 - Tooling API 元数据操作的执行提示词
- 开发工具功能提示词 - Tooling API 开发工具功能的执行提示词
- AI和智能功能提示词 - Tooling API AI和智能功能的执行提示词
- 动作和自动化功能提示词 - Tooling API 动作和自动化功能的执行提示词
- 访问和安全功能提示词 - Tooling API 访问和安全功能的执行提示词
- 高级功能提示词 - Tooling API 高级功能的执行提示词
- CRUD操作提示词 - CRUD操作的执行提示词
- 批量操作提示词 - 批量操作的执行提示词
- 查询功能提示词 - 查询功能的执行提示词
- 描述功能提示词 - 描述功能的执行提示词
- 高级功能提示词 - 高级功能的执行提示词
- Apex连接管理提示词 - Apex连接管理的执行提示词
- Apex代码编译和执行提示词 - Apex代码编译和执行的执行提示词
- 测试执行提示词 - 测试执行功能的执行提示词
- 代码覆盖率提示词 - 代码覆盖率功能的执行提示词
- 日志记录提示词 - 日志记录功能的执行提示词
- WSDL转换提示词 - WSDL转换功能的执行提示词
- SOQL查询功能提示词 - Tooling API SOQL查询功能的执行提示词
5. 会话记录
- 目录: sessions/
- 描述: 记录每个需求的完整执行过程
- 会话文件:
- Apex连接管理-完整会话 - Apex连接管理功能完整会话记录
- Apex代码编译和执行-完整会话 - Apex代码编译和执行功能完整会话记录
- 测试执行-完整会话 - 测试执行功能完整会话记录
- 代码覆盖率-完整会话 - 代码覆盖率功能完整会话记录
5. 技能文档
- 目录: skill/
- 描述: 包含项目开发所需的技能文档，指导 AI 完成特定开发任务
- 技能文档:
6. 会话记录
6. 迭代复盘
- 目录: retros/
- 描述: 包含每个迭代的复盘报告
- 复盘报告:
7. 变更日志
- 目录: changelog/
- 描述: 包含详细的变更记录
- 变更记录文档:
- 认证和会话管理变更日志 - 实现认证和会话管理功能
- CRUD操作变更日志 - 实现 CRUD 操作功能
- 批量操作变更日志 - 实现批量操作功能
- 查询功能变更日志 - 实现查询功能（SOQL 查询、QueryAll、QueryMore、SOSL 搜索）
- 描述功能变更日志 - 实现描述功能（DescribeGlobal、DescribeSObject、DescribeSObjects、DescribeLayout、DescribeTabs、DescribeQuickActions）
- 高级功能变更日志 - 实现高级功能（ConvertLead、EmptyRecycleBin、ProcessSubmitRequest、GetUserInfo、GetServerTimestamp）
- Apex连接管理变更日志 - 实现Apex连接管理功能
- Apex代码编译和执行变更日志 - 实现Apex代码编译和执行功能
- Metadata连接管理变更日志 - 实现Metadata连接管理功能
- 代码覆盖率变更日志 - 实现代码覆盖率查询和统计功能
8. 分析报告
- 目录: ./
- 描述: 包含项目需求的分析报告
- 分析报告文档:
8. SQL 脚本
- 目录: sql/
- 描述: 包含数据库表结构创建和变更的 SQL 脚本
- SQL 脚本:
- 元数据操作日志表-SQL脚本 - 创建 Tooling API 元数据操作日志表
- 开发工具功能日志表-SQL脚本 - 创建 Tooling API 开发工具操作日志表
- AI操作日志表-SQL脚本 - 创建 Tooling API AI 操作日志表
- 动作和自动化操作日志表-SQL脚本 - 创建 Tooling API 动作和自动化操作日志表
- 访问和安全操作日志表-SQL脚本 - 创建 Tooling API 访问和安全操作日志表
- 高级功能操作日志表-SQL脚本 - 创建 Tooling API 高级功能操作日志表
- SOQL查询功能操作日志表-SQL脚本 - 创建 Tooling API SOQL查询功能操作日志表
9. 接口文档
- 目录: api-docs/
- 描述: 包含提供给前端调用的接口文档和定时任务文档
- 模块索引:
- 认证和会话管理 API 文档 - 认证和会话管理接口文档
- CRUD操作 API 文档 - CRUD操作接口文档
- 批量操作 API 文档 - 批量操作接口文档
- 查询功能 API 文档 - 查询功能接口文档（SOQL 查询、QueryAll、QueryMore、SOSL 搜索）
- 描述功能 API 文档 - 描述功能接口文档（DescribeGlobal、DescribeSObject、DescribeSObjects、DescribeLayout、DescribeTabs、DescribeQuickActions）
- 高级功能 API 文档 - 高级功能 API
- Apex连接管理 API 文档 - Apex连接管理接口文档
- Apex代码编译和执行 API 文档 - Apex代码编译和执行接口文档（编译类、编译触发器、编译并测试、执行匿名代码、查询功能）
- Metadata连接管理 API 文档 - Metadata连接管理接口文档（状态、测试、刷新、关闭）
- 测试执行 API 文档 - 测试执行接口文档（运行测试、查询结果、查询覆盖率）
- 代码覆盖率 API 文档 - 代码覆盖率接口文档（查询覆盖率列表、查询覆盖率详情、总体覆盖率统计、按类型统计）
9. SQL文件
- 目录: sql/
- 描述: 包含数据库结构和初始化SQL文件
- SQL文件:
- Apex连接管理SQL脚本 - 创建Apex连接管理相关的数据库表
- WSDL转换SQL脚本 - 创建WSDL转换相关的数据库表
- Apex代码编译和执行SQL脚本 - 创建Apex代码编译和执行相关的数据库表（编译历史、测试结果、测试失败详情、代码覆盖率）
- 测试执行SQL脚本 - 创建测试执行相关的数据库表（测试成功详情、Flow覆盖率），修改测试结果表
- Flow覆盖率SQL脚本 - 创建Flow覆盖率警告表，优化Flow覆盖率表索引，创建统计视图
- 日志记录SQL脚本 - 创建Apex日志表和日志分类表，插入数据字典
- 元数据类型定义SQL脚本 - 创建元数据部署历史表
- 异步操作SQL脚本 - 创建异步操作历史表
- 删除操作SQL脚本 - 创建删除操作历史表
- 检索操作SQL脚本 - 创建检索操作历史表
- 检查部署和检索状态SQL脚本 - 创建元数据状态检查记录表
- 描述和列出元数据SQL - 创建元数据查询审计表
10. 参考代码
- 目录: reference-code/
- 描述: 包含项目参考代码和示例实现
- 参考代码:
- Salesforce SOAP API Java 客户端: com/docs/ - Salesforce 官方 WSDL 对应的 Java 源代码参考文档
- index.md - Salesforce SOAP API Java 客户端参考文档（唯一真源）
- apex-module.md - Apex SOAP API 模块说明
- metadata-module.md - Metadata API 模块说明
- tooling-module.md - Tooling API 模块说明
- partner-module.md - Partner API 模块说明
- data-dump: data-dump/ - 数据导出参考代码
- CommonServiceImpl.java - Salesforce 数据插入逻辑参考
- DataImportNewServiceImpl.java - 数据导入服务实现参考
- Salesforce SOAP API Java 客户端: com/docs/ - Salesforce 官方 WSDL 对应的 Java 源代码参考文档
10. 提示词
- 目录: prompts/
- 描述: 包含 AI 代码生成的提示词文档
- 提示词:
- Apex连接管理提示词 - Apex连接管理功能的执行提示词
- Apex代码编译和执行提示词 - Apex代码编译和执行功能的执行提示词
- 测试执行提示词 - 测试执行功能的执行提示词
- 元数据类型定义提示词 - 元数据类型定义与部署功能的执行提示词
- 部署操作提示词 - 部署操作（通用部署接口、状态查询、取消）的执行提示词
- 异步操作提示词 - 异步操作（结果查询、轮询、取消、历史记录）的执行提示词
- 检索操作提示词 - 检索操作的执行提示词
- 检查部署和检索状态提示词 - 检查部署和检索状态的执行提示词
- 描述和列出元数据提示词 - 描述和列出功能的执行提示词
11. 实施方案
- 目录: implementation/
- 描述: 包含项目实施方案和部署说明
- 实施方案:
12. 图片资源
协作基线文件
- README.md: ../README.md - 项目目标和真源入口
- CONTRIBUTING.md: ../CONTRIBUTING.md - 协作规则
- CHANGELOG.md: ../CHANGELOG.md - 变更摘要
变更日志
代码提交记录
- 2026-01-28: feat: [004-01] 实现 Tooling API 连接管理功能 - 本地（远程推送失败，认证问题）
复盘文档
- 目录: retros/
- 描述: 包含每个需求的复盘报告
- 复盘报告:
- 认证和会话管理复盘 - 认证和会话管理功能开发复盘
- CRUD操作复盘 - CRUD操作功能开发复盘
- 批量操作复盘 - 批量操作功能开发复盘
- 查询功能复盘 - 查询功能开发复盘
- 描述功能复盘 - 描述功能开发复盘
- 高级功能复盘 - 高级功能开发复盘
- Apex连接管理复盘 - Apex连接管理功能开发复盘
- Apex代码编译和执行复盘 - Apex代码编译和执行功能开发复盘
- Metadata连接管理复盘 - Metadata连接管理功能开发复盘
- 测试执行复盘 - 测试执行功能开发复盘
会话记录
- 会话记录 - PartnerAPI源org实现 - 认证和会话管理、CRUD操作、批量操作、查询功能、描述功能（已完成）
- 会话记录 - Apex连接管理 - Apex连接管理功能（已完成）
- 会话记录 - Apex代码编译和执行 - Apex代码编译和执行功能（已完成）
- 会话记录 - 测试执行 - 测试执行功能（已完成）
- 会话记录 - 代码覆盖率 - 代码覆盖率功能（已完成）
- 会话记录 - MetadataAPI源org实现 - Metadata连接管理功能（已完成）
- 会话记录 - 元数据类型定义 - 元数据类型定义功能（已完成阶段2）
- 会话记录 - Flow覆盖率 - Flow覆盖率功能（已完成）
- 会话记录 - 日志记录 - 日志记录功能（已完成阶段2）
- 会话记录 - 异步操作 - 异步操作功能（进行中）
- 会话记录 - 删除操作 - 删除操作功能（已完成阶段2）
导航说明
- 本文件是项目文档的唯一入口，所有文档变更必须在此添加链接
- 文档间引用必须使用相对路径链接
- 新文档必须使用相应目录中的模板文件