Archyno
PracticeModellierungspraxis

Namenskonventionen für Modelle

Der einzige Test, der einen Namensstreit beendet: Findet jemand, der nicht dabei war, dieses Element in sechs Monaten, indem er tippt, wie er es selbst nennen würde?

5 Min. LesezeitModelling practice3 von 4

Die kurze Antwort

  • Der einzige Test, der einen Namensstreit beendet: Findet ein Fremder das Element in sechs Monaten, indem er tippt, wie er es selbst nennen würde?
  • Substantive im Singular für Klassifizierer, Verbalphrasen für Verhalten. Order, nicht Orders - dass es viele gibt, sagt die Multiplizität an der Beziehung.
  • Der Fachbegriff gehört ins Modell, der Codebegriff in eine Notiz. Ein Modell im Vokabular des Codes ist für das Publikum unlesbar, das es brauchte.

01Der Auffindbarkeitstest#

Namensstreitigkeiten sind nicht zu gewinnen, weil beide Seiten über Geschmack streiten. Es gibt ein Kriterium, das kein Geschmack ist: Wird in einem halben Jahr jemand, der bei diesem Gespräch nicht dabei war, dieses Element finden, indem er das Wort tippt, das er dafür benutzen würde?

Diese Frage entscheidet fast jeden Fall, über den tatsächlich gestritten wird, und sie entscheidet ihn in die Richtung, in die der übliche Rat ohnehin zeigt - ein gutes Zeichen dafür, dass die Konvention nie willkürlich war. Sie hat ausserdem den Vorteil, überprüfbar zu sein: Öffnen Sie die Suche im Modell, tippen Sie das Wort, das eine Kollegin aus einem anderen Team benutzen würde, und sehen Sie nach, ob das Element zurückkommt.

02Die Konventionen, die aus dem Test folgen#

ElementNotationWas es bedeutet
KlassifiziererSubstantiv im SingularOrder, nicht Orders und nicht OrderEntity. Die Multiplizität sagt, dass es viele gibt; das Suffix sagt nichts.
OperationenVerb, dann Objektcancel(reason), nicht orderCancellation(). Die Klasse, auf der sie sitzt, liefert das Substantiv bereits.
GeschäftsprozesseVerbalphraseHandle claim, nicht Claim handling. Ein Prozess ist etwas, das getan wird.
ServicesNominalphraseClaim assessment, nicht Assess claim. Ein Service ist etwas, das angeboten wird, und genau der Unterschied zum Prozess ist der ganze Punkt.
AssoziationsendenRolle, von der Gegenseite ausmanager und reports, was die einzige Art ist, wie sich eine Assoziation einer Klasse mit sich selbst lesen lässt.
SichtenPublikum und FragePayments - what calls the ledger schlägt Payments overview, das jede je gezeichnete Sicht beschreibt.

Die Zeile zu Service gegen Prozess lohnt besonders in ArchiMate Aufmerksamkeit. Die Sprache unterscheidet, was eine Organisation tut, von dem, was sie anbietet, und beides mit derselben Grammatik zu benennen wirft diese Unterscheidung genau dort weg, wo eine Leserin sie braucht.

03Abkürzungen, Präfixe und worüber Teams streiten#

Abkürzungen: bei der ersten Definition ausschreiben, danach benutzen. Wenn das Geschäft wirklich „SLA“ sagt und nie „Service-Level-Vereinbarung“, heisst das Element SLA und seine Beschreibung enthält die Auflösung - so findet die Suche nach beiden Wörtern es. Der Fehlschlag ist ein Element namens SvcLvlAgmt, das zu keiner Anfrage passt, die irgendwer tippen würde.

Typpräfixe: nein. C_Order, IPayment, tblCustomer - das Modell weiss bereits, welcher Art jedes Element ist, und zeichnet es entsprechend. Ein Präfix fügt jedem Namen Zeichen und keinem Information hinzu, und es sortiert jede Klasse im Modell alphabetisch unter denselben Buchstaben.

Sprache: eine wählen und aufschreiben. Ein Modell mit deutschen Elementnamen und englischen Operationsnamen ist der Zustand, in den Teams driften, statt ihn zu wählen, und er verdoppelt jede Suche. Wenn das Fachvokabular nicht Englisch ist, ist das Modell nicht Englisch - das ist eine stimmige Entscheidung und viel besser als eine halbe.

In je einer Zeile

  1. 01Der Test ist, ob eine fremde Person das Element findet, indem sie das Wort tippt, das sie benutzen würde.
  2. 02Substantive im Singular für Klassifizierer; Verb-dann-Objekt für Operationen.
  3. 03Verbalphrase für einen Prozess, Nominalphrase für einen Service - die Unterscheidung trägt.
  4. 04Abkürzungen in der Beschreibung ausschreiben; nie zu etwas Unauffindbarem kürzen.
  5. 05Keine Typpräfixe, und eine Sprache pro Modell, aufgeschrieben.

04Häufige Fragen#

Was ist die beste Namenskonvention für UML-Elemente?

Substantive im Singular für Klassifizierer, Verbalphrasen für Verhalten und die Wörter, die das Geschäft ohnehin benutzt, statt der Wörter aus dem Code. Welche Konvention Sie wählen, zählt weit weniger als die Frage, ob ein Fremder das Element findet, indem er tippt, wie er es natürlich nennen würde.

Singular oder Plural bei Klassennamen?

Singular. Eine Klasse beschreibt eine Instanz, also Order und nicht Orders - dass es viele gibt, sagt die Multiplizität an der Beziehung. Der Plural gehört auf eine Datenbanktabelle, was etwas anderes ist, und genau deshalb weichen die beiden oft voneinander ab.

Fachbegriff oder technischer Begriff?

Im Modell der Fachbegriff. Sagt das Geschäft Schadenfall und der Code case, dann sagt das Modell Schadenfall und hält die Zuordnung in einer Notiz fest. Ein Modell im Vokabular des Codes lesen nur die, die den Code schon kennen - genau das Publikum, das es am wenigsten brauchte.

TeilenXLinkedIn
↑ Nach obenAlle Artikel: Practice →
In dieser Reihe
  1. 01Welche Sprache wählen
  2. 02Modellumfang festlegen
  3. 03Namenskonventionen
  4. 04Modell aktuell halten

Passend dazu

← Alle Artikel