Keywords
Looking for the Webel Best Practices for the older SysMLv1? Go here.
Dr Darren says:
In order to improve your way, you have to first have a way!Yes, you've arrived at the right place for SysMLv2! Learn how to do Model-Based Systems Engineering surgically, methodically, reliably, systematically, and most enjoyably, from Dr Darren, the Magic Cyber-Systems Engineer® (Cameo Systems Modeler®) graphical engineering wizard.
These is a new series of tips for SysMLv2, building on decades of experience refining the Webel Best Practices for SysMLv1 as used on major engineering projects such as neutron beam instruments, radio telescopes, optical telescopes, astronomical instrument projects, particle accelerators, large scale building and construction projects, green building schemes, health informatics, electronics, designing of inventions, and for modelling and encapsulating all sorts of systems from industry and science.
Each Webel Best Practice Note page is linked to annotated diagram Slide examples showing exactly the DOs and DON'Ts. And please note:
Learn more about SysMLv2 for MBSE at our unique hands-on Workshop Seminar course OR now also Online!
Supplementary cross-linked Note page
The following "super relational" tracking Note pages supplement the Webel Best Practice items for SysMLv2, and many work together with them and are cross-linked to/from them:
Webel's Best Practice items index for SysMLv2
Currently NOT ordered or prioritised. The format is:
[NOTE_TYPE_TAG, ...]{POLICY_LEVEL_TAG} LINKED_TITLE
You can also use this filtered search through all Notes on this site.
- [ANTI-PATTERN, DISPLAY, MODELLING, PATTERN, STYLE, TIP, TOOL]{TIP} Webel: SysMLv2: Cameo: TIP: Whilst long KerML expressions may be convenient in code they don't always display well in Views. Consider Divide & Conquer strategies for breaking them up into smaller expressions carried by related elements.
- [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!
- [CONVENTION, DISPLAY, MODELLING, STYLE]{OPTION} Webel SysMv2 modelling convention for tutorials and training. Metaclasses and elements from the KerML and SysMLv2 machinery are white on black or white on strong "darker" colours (blue, magenta, purple etc.) to distinguish them from user model elements
- [DISPLAY, MODELLING, PATTERN, STYLE, TIP, TOOL]{STRONG} Webel Best Practice: SysMLv2: OPTION: Use Webel convention role-based parameter names with actions for indicating transformations together with Webel display conventions (not any verbose parameter names). To find out how attend the Webel SysMLv2 course!
- [DISPLAY, MODELLING, PATTERN, STYLE, TIP]{RECOMMENDED} Webel Best Practice: SysMLv2: Prefer Views that DO NOT rely on specific packaging structures EXCEPT for dedicated package overview diagrams (and then prefer just list members in a compartment). Use of package symbols for GRAPHICAL containment can break!
- [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]{RECOMMENDED} Webel: SysMLv2: OPTION: If using = binding shorthand (instead of binding connectors) from/to context boundary parameters try listing the parameters in compartments with their bound values (rather than as parameter boundary "pin" symbols). Saves space!
- [CAVEAT, DISPLAY, GOTCHA, LIMITATION, MODELLING, PATTERN, STYLE]{INFORMATIVE} 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.
- [DISPLAY, MODELLING, OPTION, PATTERN, STYLE, TOOL]{OPTION} Webel: SysMLv2: Modelling OPTION: Links to examples of heavily compartment-oriented views (compare with relationship-oriented views). Often combined with the Symbol Style option to display inherited features. Consider for non-SysMLv2 fluent stakeholders.