Output Formats Overview
aprity generates Salesforce documentation in six distinct formats. Each format is designed for a specific audience and distribution channel, from developer-oriented Markdown files to compliance-ready PDF documents.
Format Summary
| Format | File Type | Interactive | Editable | Best For |
|---|---|---|---|---|
| Markdown | .md (zipped) | No | Yes | Developers, Git repositories, wikis |
| HTML | .html | Yes | No | Browser-based review, internal sharing |
| DOCX | .docx | No | Yes | Stakeholder reports, branded deliverables |
.pdf | No | No | Compliance, archiving, external distribution | |
| Knowledge | Salesforce articles | Yes | Yes | Experience Cloud, self-service portals |
| Confluence | Confluence pages | Yes | Yes | Atlassian teams, centralized documentation hubs |
Plan Availability
Not all formats are available on every plan. The table below shows which formats are included at each tier.
| Format | Trial | Starter | Professional | Enterprise |
|---|---|---|---|---|
| Markdown | Yes | Yes | Yes | Yes |
| HTML | Yes | Yes | Yes | Yes |
| DOCX | -- | -- | Yes | Yes |
| -- | -- | Yes | Yes | |
| Knowledge | -- | -- | -- | Yes |
| Confluence | -- | -- | -- | Yes |
If a format is not included in your current plan, it appears with a lock icon in the Generate tab. Click the locked tile to see which plan unlocks it.
Choosing the Right Format
For developers and technical teams
Markdown integrates naturally with Git workflows. Each object produces a separate file, making diffs and pull request reviews straightforward. HTML is a good alternative when you need a single shareable file with interactive navigation.
For business stakeholders
DOCX produces a professionally branded document that stakeholders can review in Microsoft Word or Google Docs. It includes a table of contents, KPI summary cards, and styled section headers. PDF is the non-editable equivalent, suitable for sign-off and archival.
For Salesforce-native teams
Knowledge publishes documentation as Salesforce Knowledge articles, making them accessible directly within Experience Cloud portals and the Salesforce help center. Combined with Agentforce, these articles power an AI documentation assistant.
For Atlassian teams
Confluence publishes documentation directly to your Confluence workspace, creating properly formatted pages with hierarchy and metadata. This requires a configured Confluence connector.
You can select multiple output formats for a single scan. aprity generates all selected formats in one pass without re-running the analysis.
Format-Specific Guides
Each format has a dedicated guide with detailed information about structure, features, and configuration: