Skip to main content

Word (DOCX) Output

The DOCX format produces a Microsoft Word document with professional formatting, branded styling, and structured content suitable for stakeholder distribution and compliance deliverables. It is available on Professional and Enterprise plans.

Document Structure

The generated Word document follows a structured layout:

  1. Cover page -- includes the document title, org name, generation date, and aprity branding.
  2. Table of contents -- auto-generated from the document's heading hierarchy.
  3. Executive summary -- high-level metrics and key findings from the scan.
  4. Object chapters -- one chapter per Salesforce object, each containing business rules, dependencies, and technical details.
  5. Appendices -- technical appendix and global analysis (when enabled).

Formatting Features

KPI Summary Cards

The executive summary section includes formatted cards displaying key metrics from the scan:

  • Total objects documented.
  • Total business rules extracted.
  • Automation breakdown by type (Triggers, Flows, Validation Rules, Process Builders).
  • Scan duration and language.

Styled Table Headers

All tables in the document use consistent styling with colored header rows, alternating row shading, and proper column alignment. This includes field definition tables, dependency matrices, and rule summary tables.

Heading Hierarchy

The document uses a four-level heading structure:

  • Heading 1 -- object name.
  • Heading 2 -- major sections (Business Rules, Dependencies, Technical Details).
  • Heading 3 -- individual rules or subsections.
  • Heading 4 -- evidence and supporting details.

This hierarchy powers the table of contents and supports navigation in Word's outline view.

Custom Templates

Enterprise plan users can upload custom DOCX templates to apply their own organization's branding to the generated documentation.

What Templates Control

  • Logo placement and sizing.
  • Color scheme (header backgrounds, accent colors, text colors).
  • Font families and sizes.
  • Header and footer content (e.g., confidentiality notices, page numbers).
  • Page layout (margins, orientation).

Using a Custom Template

  1. Navigate to the aprity admin settings.
  2. Upload your custom template file.
  3. When configuring a scan in the Generate tab, select your custom template from the template picker.
info

Custom templates must follow the aprity template specification to ensure proper content rendering. Contact support@aprity.ai for the template authoring guide.

Default Template

If no custom template is selected, aprity uses the system default template with aprity branding (indigo accent color, clean typography, aprity logo).

note

Custom templates are an Enterprise feature. Professional plan users always use the default aprity template.

Editing the Output

The DOCX file is fully editable in Microsoft Word, Google Docs, or LibreOffice Writer. You can:

  • Add manual annotations or comments.
  • Modify section content for stakeholder-specific deliverables.
  • Insert additional pages or appendices.
  • Adjust formatting and styles.
caution

Manual edits are overwritten if you regenerate documentation for the same org. If you need to preserve manual changes, save the edited file separately from the aprity output directory.

Plan Availability

PlanDOCX AvailableCustom Templates
TrialNoNo
StarterNoNo
ProfessionalYesNo
EnterpriseYesYes

When to Use DOCX

  • You need to deliver branded documentation to business stakeholders.
  • Your compliance process requires editable deliverables that reviewers can annotate.
  • You want to apply your organization's visual identity to the documentation.
  • You need a table of contents and structured navigation within a desktop document viewer.