Archyno
PracticePrax modelovania

Konvencie pomenovania v modeloch

Jediný test, ktorý ukončí spor o názvy: nájde niekto, kto pri tom nebol, tento prvok o pol roka tým, že napíše, ako by ho sám nazval?

5 min čítaniaModelling practice3 z 4

Krátka odpoveď

  • Jediný test, ktorý ukončí spor o názvy: nájde cudzí človek prvok o pol roka tým, že napíše, ako by ho sám nazval?
  • Podstatné mená v jednotnom čísle pre klasifikátory, slovesné frázy pre správanie. Order, nie Orders - že ich je veľa, hovorí násobnosť na vzťahu.
  • Do modelu patrí biznisový termín, do poznámky termín z kódu. Model písaný slovníkom kódu je nečitateľný pre publikum, ktoré ho potrebovalo.

01Skúška vyhľadateľnosti#

Spory o pomenovanie sa nedajú vyhrať, pretože obe strany sa hádajú o vkuse. Existuje jediné kritérium, ktoré vkusom nie je: nájde o pol roka niekto, kto pri tomto rozhovore nebol, tento prvok tak, že napíše slovo, ktoré by preň použil?

Táto otázka rozhodne takmer každý prípad, o ktorom sa ľudia naozaj hádajú, a rozhodne ho v smere, ktorým už bežné odporúčania ukazujú - čo je dobré znamenie, že konvencia nikdy nebola svojvoľná. Má aj tú výhodu, že sa dá overiť: otvorte vyhľadávanie v modeli, napíšte slovo, ktoré by použil kolega z iného tímu, a pozrite sa, či sa prvok vráti.

02Konvencie, ktoré z tej skúšky vyplývajú#

PrvokNotáciaČo znamená
KlasifikátoryPodstatné meno v jednotnom čísleOrder, nie Orders ani OrderEntity. Násobnosť hovorí, že ich je veľa; prípona nehovorí nič.
OperácieSloveso, potom predmetcancel(reason), nie orderCancellation(). Trieda, na ktorej operácia sedí, už podstatné meno dodáva.
Biznis procesySlovesná frázaHandle claim, nie Claim handling. Proces je niečo, čo sa práve robí.
SlužbyMenná frázaClaim assessment, nie Assess claim. Služba je niečo, čo sa ponúka, a práve ten rozdiel oproti procesu je celý zmysel.
Konce asociácieRola, z opačnej stranymanager a reports, čo je jediný spôsob, akým sa dá prečítať asociácia triedy so sebou samou.
PohľadyPublikum a otázkaPayments - what calls the ledger poráža Payments overview, ktorý opisuje každý kedy nakreslený pohľad.

Riadok o službe verzus procese je ten, ktorý sa oplatí sledovať najmä v ArchiMate. Ten jazyk odlišuje, čo organizácia robí, od toho, čo ponúka, a pomenovať oboje rovnakou gramatikou tento rozdiel zahodí presne v bode, kde ho čitateľ potrebuje.

03Skratky, prefixy a veci, o ktorých sa tímy hádajú#

Skratky: pri prvej definícii ich rozpíšte, potom ich používajte.Ak biznis naozaj hovorí „SLA“ a nikdy nepovie „dohoda o úrovni služieb“, prvok sa volá SLA a jeho popis obsahuje rozpis - takže hľadanie ktoréhokoľvek z tých slov ho nájde. Zlyhaním je prvok pomenovaný SvcLvlAgmt, ktorý nezodpovedá žiadnemu dopytu, aký by niekto napísal.

Typové prefixy: nie. C_Order, IPayment, tblCustomer - model už vie, akého druhu každý prvok je, a kreslí ho inak. Prefix pridáva znaky ku každému názvu a informáciu k žiadnemu, a abecedne strčí každú triedu v modeli pod jedno písmeno.

Jazyk: vyberte jeden a napíšte to. Model s nemeckými názvami prvkov a anglickými názvami operácií je stav, do ktorého tímy skĺznu, a nie ktorý si zvolia, a zdvojnásobuje každé hľadanie. Ak biznisový slovník nie je anglický, model nie je anglický - to je súdržná voľba a oveľa lepšia než polovičná.

Po jednom riadku na každé

  1. 01Skúškou je, či cudzí človek nájde prvok tak, že napíše slovo, ktoré by použil.
  2. 02Podstatné mená v jednotnom čísle pre klasifikátory; sloveso-potom-predmet pre operácie.
  3. 03Slovesná fráza pre proces, menná fráza pre službu - ten rozdiel je nosný.
  4. 04Skratky rozpíšte v popise; nikdy neskracujte na niečo nevyhľadateľné.
  5. 05Žiadne typové prefixy a jeden jazyk na model, zapísaný.

04Časté otázky#

Aká je najlepšia konvencia pomenovania prvkov UML?

Podstatné mená v jednotnom čísle pre klasifikátory, slovesné frázy pre správanie a slová, ktoré už používa biznis, namiesto slov z kódu. Na tom, ktorú konvenciu si vyberiete, záleží oveľa menej než na tom, či cudzí človek nájde prvok tým, že napíše, ako by ho prirodzene nazval.

Majú byť názvy tried v jednotnom alebo množnom čísle?

V jednotnom. Trieda opisuje jednu inštanciu, teda Order a nie Orders - to, že ich je veľa, hovorí násobnosť na vzťahu. Množné číslo patrí databázovej tabuľke, čo je iná vec, a práve preto sa tie dve často nezhodujú.

Mám použiť biznisový alebo technický termín?

V modeli biznisový. Ak biznis hovorí poistná udalosť a kód hovorí case, model hovorí poistná udalosť a mapovanie si poznamená. Model v slovníku kódu prečítajú len tí, čo kód už poznajú, a to je práve publikum, ktoré ho potrebovalo najmenej.

ZdieľaťXLinkedIn
↑ Späť nahorVšetky články: Practice →
V tejto sérii
  1. 01Ktorý jazyk použiť
  2. 02Vymedzenie rozsahu modelu
  3. 03Konvencie pomenovania
  4. 04Udržiavanie modelu

Súvisiace články

← Všetky články