Multi-Org Documentation Strategy
Each aprity subscription covers one Salesforce org. Documenting several orgs (production and sandboxes, or several business units) means one aprity registration per org. Contact contact@aprity.ai to set up additional orgs.
One registration per org
Each registered org is independent:
- its own installation of the aprity package and its own activation code,
- its own plan, quotas and weekly analysis,
- its own web portal address, documentation versions and reader feedback.
Feedback given on one org's documentation does not carry over to another org.
Which orgs to document
Production first
Production holds the rules your users and customers actually live with. It is the reference for audits, business decisions and migration projects. Document it first.
A sandbox, when it has a clear purpose
A second registration on a sandbox is useful when you prepare a large release: analyze the sandbox after deployment and compare its documentation with production before you go live.
Developer orgs and scratch orgs
Usually not worth it: their configuration is incomplete and changes all the time.
Sandboxes and refreshes
A sandbox refresh gives the sandbox a new Org ID. aprity no longer recognizes the refreshed sandbox as the registered org:
- On Full Copy and Partial Copy sandboxes, the aprity app shows a warning and asks an administrator to reset the local connection.
- Analyses of the refreshed sandbox are refused until it is registered again.
Plan refreshes with your aprity contact, and follow Sandbox Refresh. To avoid carrying a copied connection into a sandbox, select the aprity post-copy class FR_SandboxPostCopy when you create or refresh it.
Compare production and a sandbox
- Analyze production.
- Deploy your changes to the sandbox, then analyze it.
- Open both portals side by side and compare the objects and rules you changed.
Use the same output language in both orgs, so that the documentation uses the same terms.
Assign an owner per org
| Org | Typical owner | Focus |
|---|---|---|
| Production | Salesforce lead | Weekly analysis, feedback, audits |
| Pre-production sandbox | Release manager | Analysis before each release, comparison with production |