Namenskonventionen

Die Einhaltung der Namenskonventionen dient folgenden Aspekten:

• einheitliches und übersichtliches Erscheinungsbild der Dokumentation (einfache Lesbarkeit und Verständlichkeit)
• eindeutige Identifizierbarkeit aller Objekte (Funktionen, Ereignisse, Rollen usw.) und Vermeidung von Redundanzen
• erleichterte Wiederverwendbarkeit von bereits erstellten Objekten und
• konsistente, aussagekräftige Auswertungsmöglichkeiten durch Berichte

Damit die Mitarbeiter*innen der TU Braunschweig ein schnelles und einfaches Verständnis erzielen können und Auswertungen aussagekräftig werden, sind folgende allgemeine Namenskonventionen einzuhalten:

• Einheitliche Schreibweise: Die einmal für ein bestimmtes Wort gewählte Schreibweise ist immer beizubehalten. Ein Wechsel der Schreibweise (auch bei Abkürzungen) ist nicht zulässig, da dies zu inhaltlichen Redundanzen oder Unstimmigkeiten führt.
• Sonderzeichen zwischen Wörtern: Werden Sonderzeichen zwischen Wörtern benötigt, so sind keine Leerzeichen zu verwenden (Beispiel: „Ist-/Soll-Vergleich“). Bei Gedankenstrichen zur inhaltlichen Trennung werden Leerzeichen verwendet.
• Zeilenumbrüche und Leerzeichen: Ein Zeilenumbruch kann per ALT und Enter eingefügt werden, beispielsweise zur Verbesserung der Lesbarkeit. Bei Silbentrennung in Objektnamen ist ein „-„ ohne Leerzeichen zu verwenden. Dabei ist darauf zu achten, dass die Namen von Katalogeinträge nicht verändert werden, da sonst neue Einträge erzeugt werden. Zusätzliche Leerzeichen zu Layoutzwecken dürfen nicht eingefügt werden. Nur so werden konsistente Daten, Suchen und Auswertungen ermöglicht.
  In Rollenbezeichnungen dürfen keine Leerzeichen zur Verbesserung der Lesbarkeit verwendet werden, da sonst die Katalogeinträge verändert werden und in allen Diagrammen das Leerzeichen sichtbar ist.
• Namen: Sie sollten im Singular beschrieben und knapp und präzise sein sowie in das jeweilige Symbol hineinpassen; das Attribut „Beschreibung“ dient zur Pflege der offiziellen Bezeichnung (bzw. des offiziellen Titels).
• Rechtschreibung: Es ist die deutsche Rechtschreibung zu verwenden.
• Groß-/Kleinschreibung: Das erste Wort einer Objekt-/Modellbezeichnung wird immer großgeschrieben, auch wenn es sich nicht um ein Substantiv handelt (Beispiel: „Elektronische Rechnung prüfen“)

 

Namenskonventionen für Gateways