Skip to main content

Naming

In the process of modeling your Usecases, one of the critical steps is to name the different components accurately. Proper naming helps in maintaining clarity and consistency across your system.

Naming Conventions​

We recommend following the naming conventions from Domain-Driven Design (DDD) for consistency:

  • Commands: Use imperative verbs (e.g., AddTask).
  • Events: Use past tense (e.g., TaskAdded).

Additionally, it's advisable to name your API endpoints in alignment with your commands. This consistency helps ensure that your code and documentation are easier to understand and maintain.

How to Name Your Components​

Follow these steps to name the components of your Usecase:

  1. Open Usecase Details:

    • Click on the Usecase on the map to view its details.

  2. Navigate to the Component:

    • Locate the specific detail or component you want to name.

  3. Enter the Name:

    • Input the desired name into the field located at the top of the details box.

    UseCaseMenu

  4. Save the Name:

    • The name is saved automatically once you move away from the input field. The updates will be reflected in both the details view and on the event map.
note

Please be aware that all input fields in the Codebricks planner only accept lowercase letters and spaces. Special characters are not permitted to ensure a smooth generation experience.

Additional Tips​

  • Ensure that names are descriptive and align with the functionality of the component.
  • If the name does not update immediately or if you encounter any errors, double-check the input for typos and ensure you have adhered to the naming conventions and restrictions.