Management of Glossary Process

Overall process

The openETCS glossary process is designed to collect all important terms used in the openETCS project and assign proper definitions to all terms. In a second step all relevant relations between these terms shall be defined to develop the openETCS terminology.

The glossary project can be separated in project inputs, glossary process artifacts and glossary outputs. Inputs can be suggested by every project member.

###Project Inputs

The can range from a single term, which has to be defined, over definitions for open Terms to a complete terminology part including terms, definitions and their relations. Inputs shall be done via the issue tracker to allow comments and to assign tasks in the following way:

Guideline “How to do Term/Definition/Chance Proposals?“

A) Term Proposals

1. Go to the openETCS/Dissemination repository
2. Open the Issues tab
3. Create a New Issue
4. Add the label Glossary
5. Use the title Term Proposal Term
6. Use the following template for your Term proposal as a comment

•     Term: 
  

•      Proposed Definition (if existing):
  

•      Indication of Source:
  

•      Related Terms:
  

•      Additional Comment: 
  

  7. Assigned the issue to: yurdakul
  8. Submit Issue

B) Definition Proposals

1. Go to the openETCS/Dissemination repository
2. Open the Issues tab
3. Create a New Issue
4. Add the label Glossary
5. Use the title Definition Proposal for Term
6. Use the following template for your Definition proposal as a comment

•      Term: 
  

•      Proposed Definition:
  

•      Indication of Source (for the definition):
  

•      Related Terms:
  

•      Additional Comment:
  

  7. Assigned the issue to: yurdakul
  8. Submit Issue

C) Change Proposals for Terms or Definitions

1. Go to the openETCS/Dissemination repository
2. Open the Issues tab
3. Create a New Issue
4. Add the label Glossary
5. Use the title **Change Proposal **for Term
6. Use the following template for your Change proposal as a comment

•    Term:
  

•    Changed object (e.g.denomination, definition, source):
  

•    Original object (e.g. definition):
  

•    Proposed object (e.g. definition):
  

•    Indication of Source:
  

•    Related terms:
  

•    Reason:
  

•    Additional Comment:
  

  7. Assigned the issue to: yurdakul
  8. Submit Issue

The following pictures show where the buttons and fields for each step are found in github:

Old Github Design

New Github Design

###Glossary process

The actual glossary work including sorting definitions and preparing the database, is done by all glossary committers and led by the TU-BS (Mrs. Yurdakul). If certain glossary terms have to be discussed during inside the project an issue will be raised together with an official call for participation.

The current glossary is permanently presented under the wiki page Glossary

###Glossary outputs

The glossary process creates to kind of outputs

1. Latex glossary file For the use in all deliverables a latex file will be created with every change of the glossary. This will be available in the dissemination repository (Link Latex Glossary)

2. Specific terminology representations If specific compilations for some parts of the terminology are needed for deliverables these can be created as graphics or latex files.

Please contribute!

We are relying on your contribution to the glossary. Through the proposed glossary process, we want to make the contributions as easy as possible for everyone and keep the work open for all opinions. To be successful we need permanent propositions what kind of terms are needed and which sources are useful. Thank you very much for your contributions!