Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata
Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-003 Define abbreviations and SWIM-SERV-004 Use standard abbreviations

Requirement

Title

Abbreviations and acronyms

Identifier

SWIM-SERV-350

Requirement

A service description shall include or refer to definitions for all the abbreviations and acronyms used in the service description.

Rationale

It is best practice to document all abbreviations and acronyms used in a document.

Verification

Completeness: Verify that all used acronyms and abbreviations are defined.

Consistency: Verify that the abbreviations/acronyms and their definitions are used consistently in the service description and are consistent with those used in the information service payload.

Correctness: Not Applicable.

Examples/Notes

It is best practice to use standard abbreviations and acronyms. Example sources for standard abbreviations and acronyms:

  • ATM: ICAO and AIRM
  • Non-ATM: ISO

Level of Implementation

Mandatory

Guidance

It is possible to include abbreviations and acronyms in the service description in combination with references to external sources.

The ATM Information Reference Model (AIRM) can be searched for abbreviations and acronym using the online search tool at: https://airm.aero/dictionary/1.0.0/search

Service Metadata Schema Guidance

The list of abbreviation and acronyms is mandatory in the service metadata schema. However, the list may be empty if:

  • no abbreviation or acronym is used in the document
  • they are systematically made explicit in the text, such as in "IFR (Instrument Flight Rules)".

Verification Support

Completeness

Check that:

[  ] The service description includes or refers to definitions for all the abbreviations and acronyms used in the service description.
Consistency

Check that:

[  ] The abbreviations/acronyms and their definitions are used consistently in the service description and are consistent with those used in the information service payload.

Examples

The following example shows the content as a table.

abbreviations and acronyms

abbreviationcodeAACO

termACRIS Airport CDM Operational project
abbreviationcodeA-CDM

termAirport Collaborative Decision Making
abbreviationcodeACI

termAirport Council International

The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Example of SWIM-SERV-350 using Service Metadata Schema
"descriptionInformation": {
 "abbreviations": [{
  "name": "AACO",
  "description": "ACRIS Airport CDM Operational project"
 }, {
  "name": "A-CDM",
  "description": "Airport Collaborative Decision Making"
 }, {
  "name": "ACI",
  "description": "Airport Council International"
 }]
}

The following example uses a reference to the ATM Information Reference Model's search engine that can be used to find the definitions of the abbreviations and acronyms.

Example of SWIM-SERV-350 using Service Metadata Schema
"descriptionInformation": {
 "abbreviations": {"reference": {"url": "https://airm.aero/developers/advanced-search/1.0.0/search"}}
}

Complete examples are available at Example service description.


  • No labels