5 Naming Conventions and Definitions

This section gives definitions of all terms, including acronyms, used in the project.

Content

A dictionary containing the meaning of all the names used within the requirements specification. Select names carefully to avoid giving a different, unintended meaning.

This dictionary should build on the standard names that your organization, or industry, uses. The names should also reflect the terminology in current use within the work area.

The dictionary contains all important names that are used by the project. For each name write a succinct definition. This definition must be agreed by the appropriate stakeholders.

Motivation

Names are very important. They invoke meanings that, if carefully defined, can save hours of explanations. Attention to names at this stage of the project helps to highlight misunderstandings.

The dictionary produced during requirements is used and added to throughout the project.

Examples

Gritter Truck -- a truck used for spreading de-icing substances on roads in winter.

Considerations

Make use of existing references and data dictionaries. Obviously it is best to avoid renaming existing items unless they are so ambiguous that they cause confusion.

From the start of the project emphasise the need to avoid homonyms and synonyms and explain how they increase the cost of the project.

Later on, as the analysis progresses, this description will be expanded to define all the elementary terms that describe a gritter truck.

Gritter Truck = Truck Registration Number, Truck Capacity,

Truck Service Status

As we progress through the requirements specification each of the elementary terms will be defined in detail

Truck Capacity - the number of tonnes of grit that can be carried by a truck. From 0.5 to 2 tonnes