Downloading Generated Documentation

After a scan completes, your documentation is ready to download. This guide shows you how to find your generated files and explains what each output format contains.

Finding your completed scan

1. Open the aprity app in Salesforce.
2. Go to the Analyses tab.
3. You will see a list of all your scans, ordered by date.
4. Look for a scan with the status Completed.

:::info Scan still in progress? If your scan shows a status of Running or Generating, it is not yet complete. You can return later -- the results will be available once the scan finishes. See Running Your First Scan for estimated durations. :::

Downloading your documentation

1. Click on the completed scan to expand its details.
2. The Document Browser panel appears within the scan details, showing a download button for each output format that was included in the scan.
3. Click the button for the format you want to download.

Each format downloads as a single file. Depending on the format, this may be a .zip archive containing multiple files or a single document.

Output format details

Markdown

• File type: .zip archive containing .md files
• Structure: One file per Salesforce object, plus an index file
• Best for: Storing in Git repositories, publishing on internal wikis, editing with any text editor
• Use case: Development teams who want version-controlled documentation alongside their code

HTML

• File type: Single .html file
• Structure: A single navigable page with collapsible sections organized by object
• Best for: Quick review in any browser, sharing via email, offline reading
• Use case: Stakeholders who need to review documentation without installing any tools

DOCX (Professional and Enterprise plans)

• File type: Single .docx file
• Structure: A formatted Word document with table of contents, headers, and branded styling
• Best for: Formal deliverables, client-facing documentation, print distribution
• Use case: Consulting teams who deliver Salesforce documentation as part of project handoffs

PDF (Professional and Enterprise plans)

• File type: Single .pdf file
• Structure: A print-ready document with consistent formatting and page numbers
• Best for: Archival, compliance records, signed-off documentation
• Use case: Compliance teams who need immutable documentation for audit trails

Salesforce Knowledge (Professional and Enterprise plans)

• File type: .zip archive containing structured articles
• Structure: Articles formatted for import into Salesforce Knowledge
• Best for: Making documentation available directly inside Salesforce for end users
• Use case: Support teams who want org documentation accessible from within Salesforce

Confluence (Professional and Enterprise plans)

• File type: .zip archive containing Confluence-compatible pages
• Structure: Pages with markup ready for import into Atlassian Confluence
• Best for: Teams already using Confluence as their knowledge base
• Use case: Organizations that centralize all documentation in Confluence

Comparing formats at a glance

Format	Plan Required	File Count	Editable	Best Audience
Markdown	All plans	Multiple files	Yes	Developers
HTML	All plans	Single file	View only	All stakeholders
DOCX	Professional+	Single file	Yes	Business, Consulting
PDF	Professional+	Single file	No	Compliance, Archive
Knowledge	Professional+	Multiple articles	Yes (in SF)	Support, End users
Confluence	Professional+	Multiple pages	Yes (in Confluence)	Wiki-based teams

Re-running a scan

You can run a new scan at any time to generate updated documentation. Each scan is independent -- previous scans and their outputs remain available on the Analyses tab.

Common reasons to re-run a scan:

• Your org's metadata has changed (new objects, modified flows, etc.)
• You want documentation in a different language
• You want to add output formats you did not select initially

Next step

You have completed the full getting started workflow. For a visual recap of the entire process, see the Quick Start Video Walkthrough.

For more advanced topics, explore:

• Feature Guides -- Deep dives into specific aprity features
• How-To Guides -- Step-by-step instructions for common tasks
• Troubleshooting -- Solutions to common issues