Archyno
PracticePraxe modelování

Konvence pojmenování v modelech

Jediný test, který ukončí spor o názvy: najde někdo, kdo u toho nebyl, tento prvek za půl roku tím, že napíše, jak by ho sám nazval?

5 min čteníModelling practice3 z 4

Krátká odpověď

  • Jediný test, který ukončí spor o názvy: najde cizí člověk prvek za půl roku tím, že napíše, jak by ho sám nazval?
  • Podstatná jména v jednotném čísle pro klasifikátory, slovesné fráze pro chování. Order, ne Orders - že jich je mnoho, říká násobnost na vztahu.
  • Do modelu patří byznysový termín, do poznámky termín z kódu. Model psaný slovníkem kódu je nečitelný pro publikum, které ho potřebovalo.

01Zkouška vyhledatelnosti#

Spory o pojmenování se nedají vyhrát, protože obě strany se hádají o vkusu. Existuje jediné kritérium, které vkusem není: najde za půl roku někdo, kdo u tohoto rozhovoru nebyl, tento prvek tak, že napíše slovo, které by pro něj použil?

Tahle otázka rozhodne téměř každý případ, o kterém se lidé opravdu hádají, a rozhodne ho ve směru, kterým už běžná doporučení ukazují - což je dobré znamení, že konvence nikdy nebyla svévolná. Má i tu výhodu, že se dá ověřit: otevřete vyhledávání v modelu, napište slovo, které by použil kolega z jiného týmu, a podívejte se, jestli se prvek vrátí.

02Konvence, které z té zkoušky plynou#

PrvekNotaceCo znamená
KlasifikátoryPodstatné jméno v jednotném čísleOrder, ne Orders ani OrderEntity. Násobnost říká, že jich je mnoho; přípona neříká nic.
OperaceSloveso, pak předmětcancel(reason), ne orderCancellation(). Třída, na které operace sedí, už podstatné jméno dodává.
Byznys procesySlovesná frázeHandle claim, ne Claim handling. Proces je něco, co se právě dělá.
SlužbyJmenná frázeClaim assessment, ne Assess claim. Služba je něco, co se nabízí, a právě ten rozdíl oproti procesu je celý smysl.
Konce asociaceRole, z protější stranymanager a reports, což je jediný způsob, jak se dá přečíst asociace třídy se sebou samou.
PohledyPublikum a otázkaPayments - what calls the ledger poráží Payments overview, který popisuje každý kdy nakreslený pohled.

Řádek o službě versus procesu je ten, který se vyplatí sledovat zejména v ArchiMate. Ten jazyk odlišuje, co organizace dělá, od toho, co nabízí, a pojmenovat obojí stejnou gramatikou tenhle rozdíl zahodí přesně v bodě, kde ho čtenář potřebuje.

03Zkratky, prefixy a věci, o kterých se týmy hádají#

Zkratky: při první definici je rozepište, pak je používejte.Pokud byznys opravdu říká „SLA“ a nikdy neřekne „dohoda o úrovni služeb“, prvek se jmenuje SLA a jeho popis obsahuje rozpis - takže hledání kteréhokoli z těch slov ho najde. Selháním je prvek pojmenovaný SvcLvlAgmt, který neodpovídá žádnému dotazu, jaký by někdo napsal.

Typové prefixy: ne. C_Order, IPayment, tblCustomer - model už ví, jakého druhu každý prvek je, a kreslí ho jinak. Prefix přidává znaky ke každému názvu a informaci k žádnému, a abecedně strčí každou třídu v modelu pod jedno písmeno.

Jazyk: vyberte jeden a zapište to. Model s německými názvy prvků a anglickými názvy operací je stav, do kterého týmy sklouznou, a ne který si zvolí, a zdvojnásobuje každé hledání. Pokud byznysový slovník není anglický, model není anglický - to je soudržná volba a mnohem lepší než poloviční.

Po jednom řádku na každé

  1. 01Zkouškou je, jestli cizí člověk najde prvek tak, že napíše slovo, které by použil.
  2. 02Podstatná jména v jednotném čísle pro klasifikátory; sloveso-pak-předmět pro operace.
  3. 03Slovesná fráze pro proces, jmenná fráze pro službu - ten rozdíl je nosný.
  4. 04Zkratky rozepište v popisu; nikdy nezkracujte na něco nevyhledatelného.
  5. 05Žádné typové prefixy a jeden jazyk na model, zapsaný.

04Časté dotazy#

Jaká je nejlepší konvence pojmenování prvků UML?

Podstatná jména v jednotném čísle pro klasifikátory, slovesné fráze pro chování a slova, která už používá byznys, místo slov z kódu. Na tom, kterou konvenci si vyberete, záleží mnohem méně než na tom, jestli cizí člověk najde prvek tím, že napíše, jak by ho přirozeně nazval.

Mají být názvy tříd v jednotném nebo množném čísle?

V jednotném. Třída popisuje jednu instanci, tedy Order a ne Orders - to, že jich je mnoho, říká násobnost na vztahu. Množné číslo patří databázové tabulce, což je jiná věc, a právě proto se ty dvě často neshodují.

Mám použít byznysový, nebo technický termín?

V modelu byznysový. Když byznys říká pojistná událost a kód říká case, model říká pojistná událost a mapování si poznamená. Model ve slovníku kódu přečtou jen ti, kdo kód už znají, a to je právě publikum, které ho potřebovalo nejmíň.

SdíletXLinkedIn
↑ Zpět nahoruVšechny články: Practice →
V této sérii
  1. 01Který jazyk použít
  2. 02Vymezení rozsahu modelu
  3. 03Konvence pojmenování
  4. 04Udržování modelu

Související články

← Všechny články