Define definition vs. usage

[HendrikDahmkeLumira]

Description

We need clear set of rules that states what comes into the defintion and what we want to have in the usage.

Additionally, we need a usage of the roboticVaccumCleaner

Defintion of Done

• Rules are added to Documentations

[HendrikDahmkeLumira]

Definition

A definition in SysML v2 serves as a blueprint or template for a part or component. It should include:

1. Attributes and Properties:
   Define all the necessary attributes and properties that describe the part or component.
   Include default values if applicable.
2. Structure:
   Specify the internal structure, including sub-parts and their relationships.
   Define interfaces and connections to other parts.
3. Behavior:
   Describe the behavior or functions that the part can perform.
   Include state machines or activity diagrams if necessary.
4. Constraints:
   Define any constraints or rules that apply to the part.
   Include invariants, preconditions, and postconditions.
5. Documentation:
   Provide detailed documentation and comments to explain the purpose and usage of the part.
6. Versioning:
   Include version information to track changes over time.

Usage

A usage in SysML v2 represents an instance or application of a definition. It should include:

1. Instantiation:
   Create an instance of the part definition.
   Assign specific values to attributes and properties as needed.
2. Contextual Information:
   Specify the context or environment in which the part is used.
   Define the role or function of the part within the larger system.
3. Connections:
   Establish connections to other parts or components in the system.
   Specify how the part interacts with other parts.
4. Overrides and Extensions:
   Override default values or behaviors from the definition if necessary.
   Extend the part with additional properties or behaviors specific to the usage context.
5. References:
   Reference the part definition to ensure consistency and traceability.
6. Documentation:
   Provide usage-specific documentation to explain how the part is applied in the given context.

General Guidelines

• Separation of Concerns: Keep definitions and usages separate to maintain clarity and reusability.
• Reusability: Design definitions to be reusable across different contexts and projects.
• Consistency: Ensure that usages are consistent with their corresponding definitions.
• Traceability: Maintain clear traceability between definitions and their usages to facilitate understanding and maintenance.

[HendrikDahmkeLumira]

@manourym
@Weilkiti