devguard
Collections

Acronyms

Keep one list of the short forms your documents use, with the full form and a link to a definition, so readers never have to guess what ISMS or RTO means.

An acronym is a short form such as BCP, saved with its full form, Business continuity plan. You can link it to a definition that explains the term. In a policy or record, you mention the acronym with :. The policy PDF then prints the full form.

To mention, import, archive or delete acronyms, see Collections. Scripts and integrations: see API below.

Add an acronym

  1. Open Collections, then Acronyms, and choose Add acronym.
  2. Enter the Acronym, for example RTO.
  3. Enter the full form in Extended, for example Recovery time objective.
  4. If your texts use the plural, fill in Acronym plural and Extended plural, for example RTOs and Recovery time objectives.
  5. If you want, choose a Definition.
  6. Choose Create.

Several acronyms can share one definition. For example, 2FA and MFA can both link to "Multi-factor authentication".

  1. Create the definition first, under Definitions.
  2. Open the acronym and choose Edit.
  3. Choose the definition in Definition and save.

On the acronym's Detail tab, Linked Definition shows the definition. Related Acronyms lists the other acronyms that share it.

The acronym list: 2FA, ABAC, ACL, AES, API and more, each with its full form, plural forms where set, and the linked definition.
The Definition column shows the link. 2FA links to Multi-factor authentication.

Reference

FieldRequiredNotes
AcronymyesThe short form. 2 to 255 characters.
Acronym pluralnoFor example APIs.
ExtendednoThe full form. The policy PDF prints it in place of a mention.
Extended pluralnoThe plural of the full form.
DefinitionnoOne definition. If the definition is deleted, the link is removed.
SlugyesMade from the acronym. See Collections.

The list can be filtered by Definition and Last updated.

In a CSV import, the definitionId column takes the definition's id, not its name. Export the definitions to see their ids.

CSV columns

The template from Download CSV template has these columns. Leave slug empty to make it from the name.

acronyms.csv
slug,acronym,acronymPlural,extended,extendedPlural,definitionId
rto,RTO,RTOs,Recovery time objective,Recovery time objectives,

API

The calls are the same for all collections; see the Collections API. The path is /acronyms/.

FieldTypeRequired
organizationIdstringon create
acronymstring, 2 to 255 charactersyes
slugstring, lowercase with hyphensyes
acronymPlural, extended, extendedPluralstringno
definitionIdid of a definition in the same organizationno
POST /acronyms/
{
  "organizationId": "<organization id>",
  "acronym": "RTO",
  "slug": "rto",
  "extended": "Recovery time objective"
}

How is this guide?

On this page