Versionen im Vergleich

Schlüssel

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

...

Sv translation
languageen

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

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

Inhalt



Names are unique descriptions

A good naming immediately shows, what an element (facility type, meaning, value, etc.) is all about. Like this, all elements are distinguishable and usable in the best possible way.

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. 

DODON'T

Temperature entrance area

Temperature sales area front

Temperature sales area back

Temperature 1

Temperature 2

Temperature 3


As general as possible and as specific as necessary

A universally applicable naming makes elements fitting for as many scopes as possible. The facility type "Room" can be used 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, it 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. That's why a specific naming is necessary and also helpful to reuse it for other cooling chambers.

DODON'T

Room

Cooling chamber

Meeting room

Kitchen 2nd floor


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 knows all complex words.

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

DODON'T

Analysis

Benchmark

Scrutiny

Comparison scale


Choose consistent names

One should abide to set conventions to ensure consistency. 

DODON'T

Load profile

Load profile electricity

Load profile gas

Load profile

Usage pattern electricity

Usage gas



Avoid abbreviations

Some abbreviations are commonly known and are understand by nearly everybody like "e.g.". However, there are abbreviations that seem practical but could only 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!

DODON'T

e.g., for example

Nice to have

data point


nth

dp