Skip to content

docs: naming scheme for IDs #180

@AlexanderLanin

Description

@AlexanderLanin

Provide design decision and guidance on how elements (sphinx-needs) shall be named (id).

For example:

  • full path encoded in id
  • short readable id
  • random hash id
  • etc

Consider whether formatter or other tooling would make sense. Is a hard limit of e.g. 30 characters reasonable?

Align with process team, e.g. @hoe-jo

Previous Decision:

  • Agreed on meaningful short names
  • May be provide a sphinx extension to check the name's length to 30

Discussion Points:

  • Shall we include the "architectural element" e.g. feature in the ID for the platform/modules?
    • If the "architectural element" is taken from the directory tree, the ID might get too long, e.g. "fixed-execution-order"
    • If an abbreviation for it is taken e.g. "feo", those abbreviations need to be defined and somehow published
  • notation:
    • shall the ID consist of only underscore, numbers and small letters
    • shall the prefix consist of small letters or also capital letters?
  • Process Repo:
    • Shall the ID be similar between process and platform repo?

Current Proposal for the ID would be:
<Prefix>__<feature>__<keyword>

Decision in Process Meeting (13.2.2025)

  • id shall be small letters
  • for score id shall contain as well
  • for feature abbreviations shall be used, a glossary mapping features to abbreviations shall be defined
  • for processes the "architectural element" shall be optional

Examples:

  • feat_req__ipc__e2e_protection
  • gd_temp__requirement__attribute_status

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Done

    Status

    No status

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions