Skip to main content

How to Document Specific Objects

aprity automatically detects and documents all supported metadata in your org, but plan limits and practical considerations may require focusing on specific objects. This guide covers strategies for targeted documentation.

How Object Selection Works

aprity does not offer manual object-by-object selection. Instead, it automatically scans all supported metadata types and applies your plan's limits:

PlanMax Objects
Trial3
StarterUnlimited
ProfessionalUnlimited
EnterpriseUnlimited
info

On the Trial plan, aprity selects the 3 objects with the most automation complexity (triggers, flows, validation rules) to maximize documentation value.

Strategies for Targeting Specific Objects

Strategy 1: Use On-Demand Docs

For focused documentation on specific objects, use the On-Demand Docs feature:

  1. Navigate to the On-Demand Docs tab.
  2. Ask a specific question about the object you need documented (e.g., "Document all automations on the Opportunity object").
  3. Download the generated output.

This approach generates targeted documentation without running a full scan. See How to Use On-Demand Documentation.

Strategy 2: Run Focused Scans

Run separate scans for different functional areas of your org. While each scan covers all detected metadata, the generated documentation organizes content by object, making it easy to extract what you need.

Strategy 3: Use the Downloaded Output

After a full scan completes:

  1. Download the documentation in your preferred format.
  2. In Markdown and HTML formats, each object has its own section or file.
  3. Extract the pages for the objects you need.

Prioritization Logic

When plan limits restrict the number of objects, aprity prioritizes based on:

  1. Automation density -- objects with more triggers, flows, and validation rules are prioritized.
  2. Modification recency -- recently modified objects rank higher.
  3. Dependency centrality -- objects that many other automations reference are prioritized.
tip

If you are on the Trial plan and need specific objects documented, ensure those objects have active automations. aprity prioritizes the most automation-rich objects.