Learn about Webel's comprehensive SysMLv2 Workshop Seminar course!
VIDEO: The Webel SysMLv2/MBSE course has landed! Take a quick tour!
Webel now has a SysMLv2 Online Self-Study course with self-test Quizzes!

Webel Best Practice: SysMLv2: CAVEAT: Ports: Using Webel i/o directed feature naming may not display meaningfully with SysMLv2 ~conjugated ports. Consider instead one character feature name and still "Trust the Type" to communicate the feature role.

Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
CAVEAT
DISPLAY
GOTCHA
LIMITATION
MODELLING
PATTERN
STYLE
Policy level
INFORMATIVE
Specification keywords
SysMLv2
SysMLv2 keywords
feature
name
short name
port
PortDefinition
conjugation
port conjugation
~Port
Keywords
Relates to:
Webel Best Practice: SysMLv2: VERY STRONG RECOMMENDATION: Prefer Webel "Trust the Type" i/o port naming and Webel display conventions over verbose port usage names and verbose directed feature names. To find out how attend the Webel SysMLv2 course!
Webel Best Practice: SysMLv2: PortDefinition naming: DO NOT include the word 'Port'! Use prefix 'P_Role' OR for ports with directed features for flows consider 'F_Thing' or 'F_Stuff' where Thing or Stuff indicates a flowing discrete packet or substance.
Note that this CAVEAT applies only to use of Webel style i/o "signal processing" naming of directed features of ports, it does not apply to using i/o naming of port usages themselves.
Relates to
Related notes
[ANTI-PATTERN, DISPLAY, MODELLING, PATTERN, STYLE, TIP, TOOL]{STRONG} Webel Best Practice: SysMLv2: "Trust the Type" and use short or acronym feature names instead of verbose feature name that just repeat the Type name but as lowerCase! ANTIPATTERN: veryLongName:VeryLongName
[DISPLAY, MODELLING, PATTERN, STYLE, TIP, TOOL]{STRONG} Webel Best Practice: SysMLv2: "Trust the Type" feature name hiding. In many Views, there is no benefit, at all, in showing feature names (especially if they are needlessly verbose and just repeat the Type name but lowerCase)
[DISPLAY, MODELLING, PATTERN, STYLE, TIP]{RECOMMENDED} Webel Best Practice: SysMLv2: PortDefinition naming: DO NOT include the word 'Port'! Use prefix 'P_Role' OR for ports with directed features for flows consider 'F_Thing' or 'F_Stuff' where Thing or Stuff indicates a flowing discrete packet or substance.
[DISPLAY, MODELLING, PATTERN, STYLE, TIP, TOOL]{STRONG} Webel Best Practice: SysMLv2: VERY STRONG RECOMMENDATION: Prefer Webel "Trust the Type" i/o parameter naming and Webel display conventions over verbose parameter names. To find out how attend the Webel SysMLv2 course!
[DISPLAY, MODELLING, PATTERN, STYLE, TIP, TOOL]{STRONG} Webel Best Practice: SysMLv2: VERY STRONG RECOMMENDATION: Prefer Webel "Trust the Type" i/o port naming and Webel display conventions over verbose port usage names and verbose directed feature names. To find out how attend the Webel SysMLv2 course!
[ASSERTION, DISPLAY, NAMING, STYLE]{STRONG} Webel: SysMLv2: IMPORTANT! Specification documents and the namings used in their supporting examples have a specific purpose and the examples play specific roles. They are NOT tutorials on how to model practically in a specific tool on real projects!!!
Related notes (backlinks)
Related snippets (extracts)
Visit also
Visit also (backlinks)