Seitenhistorie

Eine gute Benennung der Elemente der Facility-Bibliothek ist unabdingbar für eine anwenderfreundliche Nutzung von QBRX. 

Im Folgenden sind die wichtigsten Konventionen aufgelistet, die bei der Benennung von Elementen der Facility-Bibliothek beachtet werden sollten.

Namen sind unverwechselbare Beschreibungen

Durch eine gute Namensgebung ist sofort erkennbar, was der Name beschreibt. Alle Elemente worum es sich handelt. Alle Elemente in QBRX sind so eindeutig voneinander unterscheidbar und optimal nutzbar. 

Werden beispielsweise mehrere, sehr ähnliche Meanings an einem Facility-Typen benötigt, dann sollten diese, trotz ihrer Ähnlichkeit, so benannt werden, dass man sie eindeutig voneinander unterscheiden kann. Das erleichtert nicht nur die Zuordnung von Datenquellen beim Erstellen von Facilities, sondern auch die Auswertung der Daten.

DO	DON'T
Temperatur Eingangsbereich Temperatur Verkaufsfläche vorne Temperatur Verkaufsfläche hinten	Temperatur 1 Temperatur 2 Temperatur 3

So allgemein wie möglich und so spezifisch wie nötig

Eine universell gültige Benennung sorgt dafür, dass Elemente für so viele Anwendungsbeispiele wie möglich benutzt werden können. Der Facility-Typ "Raum" könnte so sowohl für ein Büro, als auch für eine Küche verwendet werden. Für keinen von beiden Räumen benötigt man spezielle Typen. Gleichzeitig sollte alles so spezifisch wie möglich benannt werden, um eine optimale Anwendung möglich zu machen. Ein Kühlraum verlangt beispielsweise spezielle Konfigurationen um Daten bestmöglich auszuwerten. Deshalb ist eine spezifischere Benennung auch für die Wiederverwertung an anderen Kühlräumen sinnvoll. 

Halte es einfach und fachlich

Egal ob Englisch, Deutsch oder eine andere Sprache - bei der Namensgebung sollten einfache, allgemein bekannte Worte verwendet werden. Nicht jeder Nutzer ist Muttersprachler (vor allem in Bezug auf die englische Benutzeroberfläche) und kennt alle möglichen, komplexen Ausdrücke.

Die Ausnahmen dafür sind Fachbegriffe, die nach einer eindeutigen, im jeweiligen Umfeld bekannten Formulierung verlangen. 

DO	Don't
Analysis Benchmark	Scrutiny Vergleichsmaßstab

Namen konsistent wählen

Wiedererkennbare Muster bei der Namensgebung erleichtert allen Nutzern die Arbeit mit QBRX. Deshalb sollte bei der Benennung an ähnlichen Elementen orientiert werdenBei der Benennung sollte sich an vorher festgelegte Konventionen gehalten werden, um eine Konsistenz zu gewährleisten.

DO	DON'T
Lastgang Lastgang Elektro Lastgang Erdgas	Lastgang Lastprofil Elektro Lastkurve Erdgas

Abkürzungen vermeiden

Es gibt Abkürzungen, die allgemein bekannt sind und von jedem verstanden werden, wie zum Beispiel "z.B.". Es gibt allerdings auch Abkürzungen, die zwar praktisch erscheinen, aber aufgrund ihrer Unbekanntheit oder Doppeldeutigkeit Probleme verursachen können. Nicht jeder kennt die Abkürzung "DP" für "Datenpunkt". Stattdessen könnte sie auch als "Daft Punk" oder "Director of Photography" gedeutet werden. 

Im Zweifelsfall sollte immer davon ausgegangen werden, dass die Bedeutung einer Abkürzung nicht bekannt ist!

DO	DON'T
z.B., zum Beispiel Nice to have Datenpunkt	NTH DP

A proper naming of elements in the facility library is necessary for to guarantee a user-friendly utilization of QBRX. 

Please read and abide by the following rules carefully to ensure this!

The most important naming conventions that should be considered at all times are listed below.

Names are unique descriptions

A good naming immediately shows the connotation of an element. A good naming convention makes  all elements easily distinguishable.

If, for example, many similar meanings are required at one facility type, they all should be given straightforward but distinguishable names. This simplifies the assignment of data sources as well as the analysis of data. 

As general as possible and as specific as necessary

A universally applicable naming ensures that elements can be used for as many scopes as possible. The facility type "Room" is suitable for an office and a kitchen at the same time. There is no need for a special type for any of these two. At the same time, an element should be named as specific as necessary to allow an optimal usage. A cooling chamber, for example, requires special configurations to analyze its data in the best possible way. A specific naming helps the creator of a cooling chamber and similar faciliies to choose the right type.

Keep it simple and technically correct

No matter if Englisch, German or another language - simple, commonly known terms should be used for the naming. Not every user is a native speaker (especially regarding the Englisch user interface) and has a wide-ranging vocabulary.

Exceptions to this rule are technical terms for elements that require specific wording.

Choose consistent names

Consistency is the key to a problem-free workflow. Recognizable naming patterns simplify working with QBRX for all users.

Avoid abbreviations

Some abbreviations are commonly known and understand by nearly everybody, for example "e.g.". However, there are abbreviations that seem practical but could cause problems due to their unfamiliarity or ambiguity. Not everybody knows the abbreviation "dp" for "data point". It could also mean"Daft Punk" or "Director of Photography".

When in doubt, write it out!