SWIM-INFO-005 Information definition scope

SWIM Supporting Material

SWIM-INFO-005 Information definition scope

Page Table of Content

Requirement

Guidance

This requirement imposes the need to provide a brief narrative summary of the scope of the information covered by the information definition. This may include an explicit statement about what is not in the scope of the information definition.

The specification caters for the fact that information definitions are often contained in service descriptions. The scope information can, in effect, be considered as being the same as for the service being described. This will avoid unnecessary duplication (copy and paste) of information.

Verification Support

Completeness

Check that:

[  ] The information definition contains a textual description of the scope of the information covered by the information definition.

[  ] The scope clearly delineates what is covered by the information definition.

Examples

The example below shows how the scope information can be embedded into an XML schema. It makes use the annotation element within the XML schema definition language.

A complete example is available at: complete example.

Example of SWIM-INFO-005
<xs:annotation> <xs:documentation>   <abstract>The information definition includes AircraftIdentification, OffBlockTimes and Aerodrome elements in support of the Donlon TOBT Setting Service.</abstract>   </xs:documentation> </xs:annotation>

Status: Living Material