Skip to main content

Scan Strategy: What to Document First

A well-planned scan strategy ensures you get the most value from aprity. This guide helps you prioritize what to document first and how to build a sustainable documentation practice.

Start with Your Core Objects​

Focus your first scan on the Salesforce objects that drive your business:

  1. Revenue-critical objects — Account, Opportunity, Quote, Order
  2. Customer-facing objects — Case, Contact, Lead
  3. Custom objects with complex automation — Objects with multiple triggers, flows, and validation rules
tip

Objects with the most automation (triggers, flows, validation rules) benefit the most from aprity documentation because they are the hardest to understand manually.

Week 1: Core CRM​

Run your first scan covering the primary CRM objects. Review the generated documentation to familiarize yourself with aprity's output quality.

Week 2: Custom Business Logic​

Scan your custom objects and any objects with complex automation chains. Use the Execution Graph (Enterprise) to understand trigger execution order.

Week 3: Integration Points​

Focus on objects involved in external integrations — API endpoints, external services, and cross-system data flows.

Week 4: Security and Compliance​

Run a scan focused on permission sets, profiles, and sharing rules. Use the output for compliance documentation.

Scan Frequency Recommendations​

Org Change FrequencyRecommended Interval
Daily deploymentsWeekly scans
Bi-weekly releasesEvery 2 weeks
Monthly releasesMonthly scans
Stable/mature orgMonthly scans

Multi-Org Strategy​

For organizations with multiple Salesforce orgs (Professional and Enterprise plans):

  1. Production first — Always document your production org as the source of truth
  2. Sandbox for validation — Run a scan on your sandbox after major deployments to preview changes
  3. Separate docs per org — Each org gets its own documentation set

Using Business Rule Evolution​

Professional and Enterprise plans include Business Rule Changelog, which tracks how your business rules change between scans. Enable this feature in the Analysis Configuration to:

  • Detect rule additions and deletions between scans
  • Track changes in validation logic over time
  • Build an audit trail for compliance

Common Mistakes to Avoid​

  • Scanning everything at once on a Trial plan (you only have 4 scans total)
  • Ignoring the Feedback feature — Use it to improve documentation quality over time
  • Not scheduling recurring scans — Documentation becomes stale without regular updates