A Solution Architecture Document explains how your solution works and helps Salesforce security reviewers understand its structure, components, and functionality. This document is a required part of the Security Review submission and should provide clear insights into your app’s architecture and usage. Providing detailed documentation helps ensure a smoother and faster review process.
You can include one or more of the following in your Solution Architecture Document:
1. User Guide or Written Instructions:
- Explain how to install, configure, and use your solution.
- Provide step-by-step workflows for key features.
- Include screenshots to illustrate processes.
2. System Architecture Diagram:
- Visualize how different components interact (e.g., Salesforce, external endpoints, databases).
- Show data flows, integrations, and security controls.
- Use standard symbols for clarity (e.g., API calls, webhooks, authentication layers).
Choose the format that best explains your solution. For some apps, a diagram may be more effective, while others may benefit from detailed user instructions. Including both can provide a comprehensive understanding and help the Salesforce security team evaluate your solution quickly and accurately.
