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).

Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
OPTION
Policy level
RECOMMENDED
Specification keywords
SysML-1.6
SysML-1.7
SysMLv2
UML keywords
Stereotype
custom Stereotype
«keyword»
user defined Stereotype
Keywords
Click on the image to view it full size

In the  Webel Parsing Analysis recipe for SysML® alternative names, human-friendly names, organisation-specific names, and identifiers are tracked using tagged values for a custom stereotype «pa:term» (adapt or extend as required).

The image shows an example of this principle applied together with a more extreme form of code-like naming using the French-style "vin rouge" naming approach (which has advantages for organising inheritance hierarchies). 'The Big Friendly Giant' has a block named 'Giant_big_friendly'; a less extreme form would use "BigFriendlyGiant' (but still NO SPACES).

Human friendly names other naming alternatives can be optionally displayed on the Block symbol as tagged values and can also be extracted in query view tables
Visit also:
Webel Best Practice: 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.
Webel Best Practice: Webel Parsing Analysis: typically the quoted extract text (body) of a «snippet» is a short phrase, a sentence, or a couple of short sentences (but not dozens of sentences).
Webel Best Practice: Webel Parsing Analysis: typically the quoted extract text (body) of a «snippet» is a short phrase, a sentence, or a couple of short sentences (but not dozens of sentences).
Relates to
«pa:term»: Dealing with synonyms, alternative names, and identifiers
REFERENCE CARD: Webel Parsing Analysis for SysML1.x: Auxiliary stereotypes
Related notes
[NAMING, POLICY]{STRICT} 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')!
[OPTION]{RECOMMENDED} In Webel Parsing Analysis if you want to track elicited model elements that have not been explicitly mentioned in source text you can introduce Element-level custom tracking Stereotypes with the keywords «pa:implied» or «pa:assumed».
[TIP]{INFORMATIVE} The Webel Parsing Analysis recipe for SysML1.x does not use the ElementGroup directly, it extends it as a user-defined Snippet stereotype with keyword «snippet» and with MagicDraw Customization.
[OPTION]{STRONG} Webel Parsing Analysis: Formally, if «pa:implied» has been applied to indicate an implied elicited Element, the 'snippet' tagged value should bet set using at least one Snippet that implies it. (Note, the Snippet should have identical 'name' and 'body'.)
[CONVENTION, TIP]{STRONG} Webel Parsing Analysis: typically the quoted extract text (body) of a «snippet» is a short phrase, a sentence, or a couple of short sentences (but not dozens of sentences).
[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!"
[ASSERTION, MODELLING, NAMING, TIP]{STRICT} 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.
Related notes (backlinks)
Related snippets (extracts)
Visit also
Visit also (backlinks)