Webel Best Practice

This it the tag/keyword search page for Webel Best Practice. For a more collated list of best practice tips for Unified Modeling Language (UML^®) and Systems Modeling Language v1 (SysML^®) with explanations please visit also Webel's Best Practice policy notes for MBSE with SysMLv1/UML2 and the MagicDraw/Cameo tools.

SysMLv2: Webel: The challenge of the twice-performed action (or twice exhibited state) when combining "logical" functional analysis breakdown using performed actions with allocations to "physical" components

Webel Best Practice: “There is nothing worse than a sharp image of a fuzzy concept.” (Ansell Adams, photographer)

SysMLv2: Webel Best Practice: Prefer use performed actions and exhibited states as the primary mechanism for "logical" layer/zone systems engineering functional analysis breakdown (not SysMLv2 allocations).

SysMLv2: Webel Best Practice: If you have as many allocation definitions as allocation usages in your final model you might not be using them effectively!

SysMLv2: Webel Best Practice: An allocation definition should be of a specific "nature" (possibly related to a formal systems engineering methodology, and optionally with the "nature" further distilled using custom Metadata).

Webel Best Practice: SysMLv2: "Trust the Type": When redefining a subject (within any element kind) ALWAYS also include the :Type in the redefinition declaration (even if it's a bit tedious and a bit WET).

Webel: SysMLv2: Cameo: Modelling Best Practice: Links to examples of _DELIBERATELY_ very large Views (diagrams) that are candidates for "Divide & Conquer" strategies. Some linked examples are AntiPatterns!

Webel Best Practice: SysMLv2: States: Instead of an "empty" entry action (that does nothing) with a succession to an initial state prefer a start:StateAction with a transition to the initial state EXCEPT where conditional successions are needed.

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.

Webel Best Practice: SysMLv2: "Trust the Type" functional analysis: When referencing a performed action or exhibited state ALWAYS also include the :Type in the declaration (even if it's a bit tedious and a bit WET). Helps avoid also verbose usage names!

Webel Best Practice: SysMLv2: Prefer transition (not succession) from start:StateAction

Webel: SysMLv2: Modelling: When parameters are bound using = binding without flow connectors the "pin" boundary symbols end up "floating". If you instead list all parameters in a compartment do still also show any actually connected ones as "pin" symbols.

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!

Webel Best Practice: SysMLv2: Prefer graphically clearer explicit binding connectors from/to context boundary parameters over parameter = binding shorthand.

Webel Best Practice: SysMLv2: Avoid naming features after their owner where it is clear what owns them.

Webel Best Practice: SysMLv2: Where port usages aren't connected just list them in compartments (do not show them as port boundary symbols).

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)

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!

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!

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!!!

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: SysMLv2: Cameo: Modelling Best Practice: EITHER display a feature in a compartment (preferred for non-structured) OR display the symbol of the feature (may be necessary if structured) but NOT both (except for special educational illustration).

Webel: SysMLv2: Terminology: in some Webel slides and diagrams the little rectangular parameter boundary symbols with directed feature arrows are INFORMALLY called "pins" (borrowing terminology from SysMLv1) but this is NOT a formal SysMLv2 term.

Webel: SysMLv2: Cameo: Modelling Best Practice: For parameters prefer compartment view (where available) over boundary symbols UNLESS you need to show relationships from the symbols OR have special reasons (such as educational illustration).

Webel: SysMLv2: Cameo: TIP: You can move parameter symbols (the little boxes with arrows) around the boundary of their owner's symbol to save space and improve readability. Parameters displayed on the left (default Cameo layout) take up a lot of space.

Webel: SysMLv2: Cameo: Modelling Best Practice: For non-structured features prefer compartment views with feature values over symbols UNLESS you need to show relationships from feature symbols OR have special reasons (such as educational illustration).

Webel: SysMLv2: Cameo: Modelling Best Practice: Adopt a tight packing strategy leveraging the Cameo grid (but DO NOT obscure the ends of relationship arrow symbols).

Webel: SysMLv2: Cameo: Modelling Best Practice: Links to examples of appropriate and effective use of outline colours for special highlighting with specializations and hierarchies. BUT does not always work well if overdone!

Webel: SysMLv2: Prefer member ownership relationship symbols over Package symbol member containment (which can break if you change the packaging). [POSSIBLE EXCEPTION: Modelling readonly library packages.]

Dr Darren's SysMLv2 dream: Just 'att' instead of 'attribute' as code keyword.

Webel's Best Practice policy notes for MBSE with SysMLv2 and the Cameo (CATIA Magic) tools

Keywords

The Webel Best Practice items for SysMLv1 (and for supporting UML2) - tuned for the MagicDraw/Cameo tools - represent the world's most comprehensive guide to robust, fluent, enjoyable, consistent modelling for Model-Based Systems Engineering (MBSE), developed over two decades, and proven to work on extremely demanding real-world projects!