Skip to content

fix implementation review findings#717

Merged
RolandJentschETAS merged 13 commits into
eclipse-score:mainfrom
etas-contrib:improvement_fix_implementation_review_findings
Jun 29, 2026
Merged

fix implementation review findings#717
RolandJentschETAS merged 13 commits into
eclipse-score:mainfrom
etas-contrib:improvement_fix_implementation_review_findings

Conversation

@RolandJentschETAS

Copy link
Copy Markdown
Contributor

This pull request makes significant updates to the implementation process requirements and guidance documentation. The main focus is on clarifying the optional nature of detailed design documentation, simplifying and strengthening requirements for diagram and unit/interface attributes, and emphasizing consistency and traceability between documentation and source code. Several redundant or overly prescriptive requirements have been removed, and naming conventions are now highlighted as central for traceability.

Key changes include:

General Requirements and Documentation:

  • Clarified that detailed design description files and diagrams are optional, but if provided, must follow specific consistency and traceability rules.
  • Updated guidance to stress that naming in diagrams and descriptions must match source code to ensure traceability and prevent outdated or inconsistent documentation. [1] [2]

Diagram and Attribute Requirements:

  • Simplified diagram requirements: diagrams now require a unique name (not ID) and a description, with previous mandatory attributes (security, safety, status) and linkage requirements removed. [1] [2] [3]
  • Diagram consistency checks now focus on alignment with source code and design principles, rather than checking for a fixed set of mandatory attributes.

Unit and Interface Requirements:

  • Replaced unique ID requirements for units and interfaces with a focus on proper, descriptive naming that follows a project-wide convention for traceability.
  • Unit and interface descriptions are now required in the source code, with guidance on what the documentation should cover and the importance of keeping it up to date.

Work Product and Editorial Updates:

  • Minor editorial improvements for clarity and consistency in the implementation work products documentation. [1] [2] [3]

These changes streamline the documentation process, reduce unnecessary overhead, and ensure that all design artifacts remain consistent with the evolving codebase.


References:
[1] [2] [3] [4] [5] [6] [7] [8]

@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@RolandJentschETAS RolandJentschETAS changed the title fix implementation review findngs fix implementation review findings Jun 19, 2026
Comment thread process/process_areas/implementation/guidance/implementation_process_reqs.rst Outdated
Comment thread process/process_areas/implementation/guidance/implementation_process_reqs.rst Outdated
Comment thread process/process_areas/implementation/guidance/implementation_process_reqs.rst Outdated
Comment thread process/process_areas/implementation/guidance/implementation_process_reqs.rst Outdated
Comment thread process/process_areas/implementation/guidance/implementation_process_reqs.rst Outdated
Comment thread process/process_areas/implementation/implementation_concept.rst Outdated
Comment thread process/process_areas/implementation/implementation_concept.rst Outdated
@PandaeDo PandaeDo requested a review from hoe-jo June 19, 2026 07:58

@aschemmel-tech aschemmel-tech left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see inline comments

Comment thread process/process_areas/implementation/guidance/implementation_guideline.rst Outdated
Comment thread process/process_areas/implementation/guidance/implementation_guideline.rst Outdated
PandaeDo
PandaeDo previously approved these changes Jun 26, 2026

@PandaeDo PandaeDo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine from my side. As discussed I think we should wait for a approval of @hoe-jo

@aschemmel-tech aschemmel-tech left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my comments resolved

@RolandJentschETAS RolandJentschETAS merged commit 1547308 into eclipse-score:main Jun 29, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants