9.6 KiB
9.6 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实现 - 进行中 - 高
2. 设计文档
- 目录: design/
- 描述: 包含系统架构设计、模块设计和接口设计
- 设计文档:
3. 提示词 (Prompt)
- 目录: prompts/
- 描述: 包含各需求的专用代码生成提示词
- 提示词文档:
3. 架构决策
- 目录: decisions/
- 描述: 包含架构决策记录 (ADR)，记录重要的架构决策过程
- ADR文档:
- 认证和会话管理技术选型 - 已接受
- 连接管理技术选型 - 已接受（Tooling API 连接管理）
- CRUD操作技术选型 - 已接受
- 批量操作技术选型 - 已接受
- 查询功能技术选型 - 已接受
- 描述功能技术选型 - 已接受
- 高级功能技术选型 - 已接受
4. 提示词库
- 目录: prompts/
- 描述: 包含 AI 提示词模板和最佳实践
- 模板: 0000-template.md
- 提示词文件:
5. 会话记录
- 目录: sessions/
- 描述: 记录每个需求的完整执行过程
- 会话文件:
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）
- 连接管理变更日志 - 实现 Tooling API 连接管理功能
8. 分析报告
- 目录: ./
- 描述: 包含项目需求的分析报告
- 分析报告文档:
8. SQL 脚本
- 目录: sql/
- 描述: 包含数据库表结构创建和变更的 SQL 脚本
- SQL 脚本:
9. 接口文档
- 目录: api-docs/
- 描述: 包含提供给前端调用的接口文档和定时任务文档
- 模块索引:
- 认证和会话管理 API 文档 - 认证和会话管理接口文档
- CRUD操作 API 文档 - CRUD操作接口文档
- 批量操作 API 文档 - 批量操作接口文档
- 查询功能 API 文档 - 查询功能接口文档（SOQL 查询、QueryAll、QueryMore、SOSL 搜索）
- 描述功能 API 文档 - 描述功能接口文档（DescribeGlobal、DescribeSObject、DescribeSObjects、DescribeLayout、DescribeTabs、DescribeQuickActions）
- 高级功能 API 文档 - 高级功能 API
- 连接管理 API 文档 - Tooling API 连接管理接口文档
9. 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 源代码参考文档
11. 实施方案
- 目录: implementation/
- 描述: 包含项目实施方案和部署说明
- 实施方案:
12. 图片资源
协作基线文件
- README.md: ../README.md - 项目目标和真源入口
- CONTRIBUTING.md: ../CONTRIBUTING.md - 协作规则
- CHANGELOG.md: ../CHANGELOG.md - 变更摘要
变更日志
代码提交记录
复盘文档
会话记录
- 会话记录 - PartnerAPI源org实现 - 认证和会话管理、CRUD操作、批量操作、查询功能、描述功能（已完成）
导航说明
- 本文件是项目文档的唯一入口，所有文档变更必须在此添加链接
- 文档间引用必须使用相对路径链接
- 新文档必须使用相应目录中的模板文件