Webel: SysML: DO NOT sacrifice modelling naming conventions for the mere sake of carrying organisation-specific names! Instead use tagged values of custom stereotypes as metadata to carry alternative names in parallel with systematic model element names.

Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
ASSERTION
MODELLING
NAMING
TIP
Policy level
STRICT
Specification keywords
fUML-1.3
fUML-1.4
SysML-1.6
SysML-1.7
SysMLv2
SysPhS-1.1
UML-2.5.1
UML keywords
NamedElement::name
NamedElement
tagged value
Stereotype
stereotype Property
«keyword»
custom Stereotype
Keywords

Webel recommends that in SysML you DO NOT sacrifice modelling naming conventions for the mere sake of carrying organisation-specific names! Instead use tagged values of custom stereotypes as metadata to carry alternative names in parallel with systematic model element names.

For example, you can use the custom stereotype Term with keyword «term» and tagged values such as 'localName', 'ourName', 'ourId' etc. (where 'our' of course might instead reference your organisation).

A stricter code-like example using French-style "vin rouge" naming is shown here:

Webel Best Practice: Webel Parsing Analysis for SysML: Track and display alternative names, human friendly names, organisation-specific names, and identifiers using tagged values for a custom stereotype «pa:term» (adapt or extend as required).
Dr Darren says:
This is one of the most important tips for fluent, enjoyable Model-Based Systems Engineering (MBSE) with SysML on this entire site! I use this approach all the time, have for years, and it works. It also DOES communicate to stakeholders fine. Try to use organisation-specific names directly on model element names throughout your model (instead of systematic ones like the Webel Best Practice items) and all you will get is a complete mess. It will NOT be easier for others to read. And you will sacrifice a heap of modelling power. Don't do it!
The Webel Best Practice items for SysML (and for supporting UML) - 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! Learn more by attending the Webel IT Australia course for MBSE with SysML.

Visit also:

Webel Best Practice: DO NOT use spaces in Property names or Class/Block names! If you want to communicate familiar names of elements within an organisation use a custom stereotype and tagged values (such as 'aka')!
Webel Best Practice: Webel Parsing Analysis for SysML: Track and display alternative names, human friendly names, organisation-specific names, and identifiers using tagged values for a custom stereotype «pa:term» (adapt or extend as required).
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!"
Relates to
Related notes
[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.
[CONVENTION, NAMING, STYLE]{STRONG} FlowProperty naming. Use anonymous or just 'i' for in, 'o' for out, and 'io' (or 'oi') for inout. "Trust the Type". For conjugation ~InterfaceBlock use 'o' for in, 'i' for out, and 'io' (or 'oi') for inout.
[NAMING, POLICY]{STRONG} Prefer anonymous Actions, or if they must be named, prefer code-like 'lowerCamelCase' or completely 'lower case' (if you do absolutely insist on having spaces in action names, but please no other punctuation).
[NAMING, POLICY]{STRICT} SysML: Naming: Always use either anonymous or first letter lower case for Property, ObjectNode and InstanceSpecification names; no exceptions (unless using names to "quote text")! Valid: 'lowerCamelCase' OR 'tla' vs TLA acronym OR 'uCC' vs UpperCamelCase
[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!
[CAVEAT]{OPTION} SysMLv1: When using model queries (such as tables) for compliance with some older systems engineering docs you may not always be able to use anonymous Property names and anonymous instance level element names. Or try the owner context or the ID!
[NAMING, STYLE] Webel has a proposal for clearly revealing anonymous typed elements in SysML callouts and on derived Properties from operation queries.
[CONVENTION, MODELLING, NAMING, TIP]{STRONG} Webel: If you must name your Ports or Pins, name them simply 'i', 'o', or 'io' (or 'oi') to indicate direction UNLESS you have to indicate a special role like 'iRole', 'oAuxiliary'. DO NOT use Port or Pin names like 'input', 'output', etc.
Related notes (backlinks)
Related snippets (extracts)
Visit also
Visit also (backlinks)