Documentation terminology

Use the documentation product names

Every product has one documentation name, and every page uses that name. Take the current name from the product’s Overview page, the root of its section. This guide does not restate the names, because a copy is wrong the day a name changes.

When a marketing name differs from the documentation name, write the marketing name once, in parentheses, at the first mention. After that, the documentation name stands alone.

Azion renamed its products and platform resources over time. The old names still appear in old pages, URLs, and directory names, so they can look current. Treat these names as history, not as synonyms.

Name the resource the reader works on

Azion describes what it offers with four terms. They are related concepts, not four levels of one hierarchy: a resource may or may not be a Product, and a feature can belong to the Platform or to a resource.

A Product is a go-to-market decision, not a billing test: it does not have to be sold or metered on its own. A feature is always scoped, so state whether it applies to the Platform or to a resource.

Documentation writes in the Platform Resource nomenclature: it names what the reader creates or manages, and it joins that resource to the Product with a verb. The Product name, in Title Case, appears where the page means the offering: the section title, the first mention, and the definition block of an Overview.

Applications, Firewall, Connectors, Workloads, Custom Pages, and Certificate Manager are Platform Resource types, not products. The thing the reader creates is an instance, lowercase: an application, a firewall, a connector.

• Correct: Configure a firewall to protect the application.
• Correct: Web Application Firewall (WAF) inspects the requests that reach a firewall. Apply a WAF rule set to the firewall.
• Incorrect: Firewall is a product that includes WAF.
• Incorrect: WAF is a Firewall module.
• Correct: the sidebar row that opens WAF inside Firewall reads WAF, never Firewall WAF or Web Application Firewall, because a label never repeats its parent.

The words module and add-on are retired. What a page used to call a module is a Product enabled on a resource, such as Application Accelerator, Image Processor, WAF, or Network Shield. It can also be a feature of a resource, such as Tiered Cache, or a function instantiated on an application or a firewall. The retirement covers the classification of an Azion offering, nothing else. Modules stays where the Console renders it, inside a click path: In the **Modules** section, turn on Application Accelerator. A JavaScript module, an ES module, and an API field such as modules.application_accelerator keep their names.

Azion Console, the API, the CLI, and the Terraform Provider are the Platform’s interfaces, not resources. A field or an option on a resource is a setting, not a feature.

Give a plural-form name a singular verb

A product name or a resource type name names one thing, whatever its form. Applications, Functions, and Connectors each take a singular verb: Applications caches content, Functions runs your code — never Applications cache. Portuguese agrees the same way: Functions executa suas funções, never executam.

Lowercase the thing the customer builds

A product name and a resource type name are capitalized. The thing a customer creates with them is a common noun, and it stays lowercase.

• Correct: Use **Applications** to build your own applications.
• Correct: **Functions** runs your functions on Azion's distributed infrastructure.
• Incorrect: Deploy your first Application.

The distinction keeps the type name meaningful. A page that capitalizes both leaves the reader unable to tell the type from the instance.

Keep historical names in historical documents

Changelogs, release notes, and dated agreements record what was true on the day of publication. These documents keep the product names they shipped with. A Terms of Service from 2020 keeps the names that were correct in 2020.

Do not rename products in a historical document. An updated name rewrites the record and detaches the text from its date.

Leave these terms in English

These terms are generic technical vocabulary, not product names. They stay in English in both languages:

data center · serverless · on-premise · template · compliance · e-commerce · e-mail · keywords · meta description

A translation creates a second name for a concept the reader already knows in English. The documentation uses one term for one concept, on every page.

The strings edge and edge computing also stay untranslated where they already appear. That is guidance for translation, not permission to use them. New text names Azion’s distributed infrastructure instead.