Skip to main content

Multi-Language Documentation

aprity writes your documentation in one of six languages. All six are available on every plan.

LanguageCode
Englishen
Frenchfr
Spanishes
Germande
Italianit
Portuguesept

Two different settings are involved, and they are independent:

  • the documentation language -- the language of the content, chosen when a scan is launched;
  • the portal language -- the language of the portal's menus and buttons, chosen by each reader.

Choosing the documentation language​

  1. In the aprity app in Salesforce, open New Analysis.
  2. Under Settings for this analysis, pick the Documentation language.
  3. Click Run the analysis.

The language applies to everything the scan produces:

  • section headings, labels and badges,
  • explanations of business rules, objects, processes and integrations,
  • the Migration backlog derived from the documentation.

A scan produces one language. To publish the documentation in another language, launch a new scan in that language -- keeping in mind the limit of one scan per week.

Choosing the portal language​

Each reader can switch the portal interface language from the user menu. This changes menus, buttons and messages; it does not translate the documentation content, which stays in the language of the scan.

How content is written in each language​

  • Structural text (headings, labels, navigation) comes from a maintained translation catalog. It is identical from one scan to the next.
  • Explanations are written directly in the chosen language, not translated from English, so they read naturally.
  • Salesforce vocabulary such as Flow, Trigger or Validation Rule is kept in its usual form when there is no established translation.

What is never translated​

  • API names of objects, fields and automations (for example Custom_Object__c or Account.AnnualRevenue), so the documentation stays traceable to your metadata.
  • Your org's own content: field labels, picklist values, error messages and descriptions appear as your administrators wrote them.
tip

If your teams use specific internal terms, declare them in your vocabulary so the documentation uses them.

Changing the language of existing documentation​

Documentation already published keeps its language. When two consecutive scans use different languages, the change history does not compare them: rules written in two languages cannot be compared honestly.