Icon class icon_class far fa-sticky-note icon_class_computed far fa-sticky-note Note kind NAMING POLICY Policy level STRONG UML keywords Element::owner NamedElement::name Relates to Figure D.3 - Establishing Structure of the User Model using Packages and Views Figure D.13 - Acceleration Requirement Relationships Related notes Related notes (backlinks) [GOTCHA, ISSUE, TOOL]{INFORMATIVE} Webel: SysMLv1: MagicDraw/Cameo: CON: Using anonymous property and/or action names is not ideal for Element Compartment and Note callout displays when Usage level allocation is used. But allocation table and matrix views are better anyway. [MODELLING, NAMING, TIP]{STRONG} Webel: SysML: "Really long human friendly element names with spaces make my diagrams easier to read". Dr Darren says "No they don't! Prefer code-like naming (or anonymous for typed elements) wherever possible. Use custom tagged values for other names!" [MODELLING, NAMING, TIP]{RECOMMENDED} Webel: SysMLv1: Dr Darren for LinkedIn: On "Trusting The Type" and avoiding unnecessary verbose repetitive Property names ... unless you really, really need them and really do have reasons to use them, and then only use concise role indicators anyway! [DISPLAY, MODELLING, NAMING, STYLE]{OPTION} UML/SysML: In Internal Block Diagrams: If you have a Port with a name that indicates a unique role AND and if there is an ItemFlow on a Connector that implies or suggests the Type of the Port, consider hiding the Type on the Port symbol. [NAMING, POLICY, STYLE] "Trust the Port or Pin Type!" - Often the name of the Type of an anonymous Port or Pin is completely sufficient to indicate its role, unless a clear indication of its direction or unique role is required. [DISPLAY, MODELLING, NAMING, STYLE]{TIP} UML/SysML: In Internal Block Diagrams: Consider hiding the name of a named Port or Property in a Diagram if its Type is sufficient to indicate its role. [POLICY]{STRONG} About the Single Source of Truth (SSOT) and Don't Repeat Yourself (DRY) principles [NAMING, POLICY, STYLE]{STRONG} SysML: Webel: "Trust the Type!" - Often the name of the Type of an anonymous Property or instance-level element is completely sufficient to indicate its role - unless multiple Properties of the same Type have different roles within the same owner context! Related snippets (extracts) Visit also Visit also (backlinks) External links Don't repeat yourself (DRY) Flags Book traversal links for "Trust the Namespace" - DO NOT repeat information in names of owned elements that can be gleaned from the owner or ancestor (and is usually easily shown using display options). It is WET, it breaks the DRY principle! Previous Up Next
