Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

Um das zu gewährleisten, sollte sich bei der Namensfindung an die unten stehenden Regeln gehalten werden. 

Eindeutige und unverwechselbare Namen wählen!

...

Ein Name ist immer die bestmögliche Beschreibung!

Am Namen eines Elements ist sofort erkennbarJeder, der mit QBRX arbeitet, muss wissen, was gemeint ist und welche Daten er gerade sieht. Aus der Benennung von Elementen muss eindeutig hervorgehen, worum es sich handelt. Eine gute Namensgebung Der Name sorgt dafür, dass jedem klar ist, was dargestellt wird. 

Beispiel

Eindeutigen und unverwechselbaren Namen wählen!

Durch eine gute Namensgebung ist ein Element unverwechselbar ist und eindeutig von anderen unterschieden werden kannunterscheidbar.

Beispiel: Werden mehrere, sehr ähnliche Meanings an einem Facility-Typen benötigt, dann sollten diese, trotz ihrer Ähnlichkeit, so benannt werden, dass man sie bei der Auswertung voneinander unterscheiden kann. Drei Thermometer einer Verkaufsfläche sollten demnach nicht "Temperatur 1, 2 und 3" heißen, sondern eher "Temperatur Eingangsbereich, vordere Verkaufsfläche und hintere Verkaufsfläche". Das erleichtert nicht nur die Zuordnung von Datenquellen beim Erstellen von Facilities, sondern auch die Auswertung der Daten.

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

...

Beispiel: Der Facility-Typ "Raum" ist so allgemein gehalten, dass er für eine Vielzahl an Facilities verwendet werden kann, die keine besonderen Anforderungen haben, wie zum Beispiel Büros. Es gibt jedoch auch spezifischere Raum-Typen wie "Kühlraum", die für Facilities geeignet sind, die spezielle Eigenschaften für die Auswertung ihrer Daten benötigen. Wofür die Der Facility-Typ dann genau benutzt werden kann ist von der Konfiguration abhängig. Der Name "Raum" lässt eine breite Nutzung des Typen zu

Ein Name ist immer die bestmögliche Beschreibung!

und trotzdem weiß jeder Nutzer, was damit gemeint ist.

Fasse dich kurz!

Schnell und einfach erfassbar 

Namen konsistent wählen!

Bei der Benennung sollte sich an vorher festgelegte Konventionen gehalten werden, um eine gewisse Konsistenz zu gewährleisten.

Es sollte vorher eine dementsprechende Einigung getroffen werden, die in einer Dokumentation festgehalten wird. 

Beispiel: Es gibt die Meanings "Lastgang", "Lastgang Elektro" und "Lastgang Erdgas". Sollte ein weiteres Meaning dieser Art benötigt werden, wäre es ratsam, es ebenfalls "Lastgang ..." zu nennen und nicht mit einer anderen Terminologie zu arbeiten,. Selbst wenn ein anderes Wort im Prinzip (fast) das selbe ausdrückt, wie "Lastprofil", kann eine unterschiedliche Benennung zu Verwirrung führen.

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 mehr Probleme verursachen als lösen. Nicht jeder kennt die Abkürzung "NTH" für "nice to have". Stattdessen könnte sie auch als "Nothing" oder "No Therapy Helpful" gedeutet werden. 

...