Skip to content

Nomenclature Guideline

idelatorre edited this page Oct 24, 2013 · 3 revisions

This guidance aims to explain the rules for naming the configuration items (CI) of openETCS project.

Nomenclature

The CI nomeclature has the following components:

  1. Prefix: It consists of characters that identifies the type of the configuration Item.
    1. D = Deliverables
    2. CD= Contractual Documents
    3. PR = Progress Report
    4. IR = Internal Reports
    5. SD = Suporting Documents:
      1. SDT: Templates
      2. SDP: Procedures
  2. Task id: An alphanumeric code that represents the openETCS task to which the CI is related.
  3. Name: The selected name should be relevant to the task and content

Version numbers should not be reflected in file names, only within the file of an artifact.

Once a release is done, the latest state of this file can be copied to another location (folder) to make it available for download. These copies are not changed anymore and can include the version number in the file name. see versioning artifacts in ecosystem wiki

Example: D1.3.1_QAPlan

Nomenclature

Example of a release: D1.3.1_QAPlan_0.9.5.4