Skip to main content

How to Generate Compliance-Ready Documentation

aprity can generate documentation suitable for compliance audits, security reviews, and regulatory requirements. This guide explains how to configure a scan for compliance-ready output.

:::caution Portal-only delivery aprity does not produce downloadable PDF or DOCX files. All documentation is delivered through the aprity web portal (see Customer Portal). For compliance submissions, share the portal's deep-link URLs to specific pages, or use the StorySite Excel/CSV export for a structured backlog view (see StorySite). On the Intelligence and Trial plans you can also publish to Salesforce Knowledge or Confluence, making documentation available where auditors already work. :::

Prerequisites

  • An active aprity account on any plan (Documentation, Intelligence, or Trial).
  • At least one completed scan is recommended before generating compliance documentation.

Steps

  1. Open the aprity app in Salesforce.
  2. Navigate to the Generate tab.
  3. Configure scan options (language, changelog depth).
  4. Click Generate Now to start the scan.
  5. Once the scan completes, open the aprity web portal to browse and share the generated documentation.

What Compliance Documentation Includes

aprity-generated documentation covers several areas relevant to audits:

  • Security Baseline -- permission sets, profiles, and field-level security analysis
  • Access Catalog -- who has access to what, mapped across profiles and permission sets
  • Automation Inventory -- complete list of triggers, flows, validation rules, and their purposes
  • Global Analysis -- cross-object dependency analysis (available on all plans)
  • Dependency Map -- how objects and automations relate to each other
  • Data Model -- object relationships, field types, and constraints

Tips for Audit Preparation

  • Run a fresh scan shortly before the audit to ensure documentation reflects the current state of the org.
  • Share deep-link URLs from the portal for specific object or rule pages -- each URL is stable and stable-authenticated via Salesforce SSO.
  • Schedule recurring scans to maintain an up-to-date compliance baseline. See How to Schedule Recurring Scans.
tip

Combine aprity documentation with your org's change management records for a complete audit trail. aprity documents the current state; your change management process documents the history.