fix implementation review findings#717
Conversation
|
The created documentation from the pull request is available at: docu-html |
| std_req__aspice_40__SWE-3-BP2[version==1] | ||
|
|
||
| Each diagram shall have a unique ID. It shall consist of three parts: | ||
| Each diagram shall have a unique name. It shall consist of three parts: |
There was a problem hiding this comment.
| Each diagram shall have a unique name. It shall consist of three parts: | |
| Each diagram shall have a unique ID. It shall consist of three parts: |
We also named it unique ID in the other requirements like https://eclipse-score.github.io/process_description/pr-717/process_areas/architecture_design/guidance/architecture_process_reqs.html hat are using names. To the aspect to have it similar I would recommend to change it back.
There was a problem hiding this comment.
Yes, but thats an different case. In the architecture, we have this all as Sphinx Objects. Here it is simply a plant UML file without any ID. We could only say, that path + filename build the ID.
|
|
||
| This means for example that the word "shall" is not allowed in the title for all diagram. | ||
|
|
||
| .. gd_req:: Diagram attribute: security |
There was a problem hiding this comment.
Whey the attributes are deleted? I guess we should keep them if a diagram is used.
There was a problem hiding this comment.
As described above. Units are within a component and inherits all properties from it. Therefore it makes no sense (independently that it would be unclear how to do) to add security and safety to a plantuml / drawio inside the detail design.
|
|
||
| .. gd_req:: Unit attribute: UID | ||
| :id: gd_req__impl_unit_uid | ||
| .. gd_req:: Unit naming |
There was a problem hiding this comment.
| .. gd_req:: Unit naming | |
| .. gd_req:: Unit attribute: UID |
There was a problem hiding this comment.
See above
| :complies: std_req__iso26262__software_843[version==1], std_req__aspice_40__SWE-3-BP1[version==1] | ||
|
|
||
| Each unit shall have a unique ID. It shall consist of three parts: | ||
| Each unit shall have a proper naming, which is unique within the component and |
There was a problem hiding this comment.
Please also consider text and following text against comment regarding UID / naming
There was a problem hiding this comment.
Units have no spinx representation. Therefore it is unclear what a UID shall be.
| Consider the project's naming convention. | ||
|
|
||
| .. gd_req:: Unit attribute: description | ||
| .. gd_req:: Unit description |
There was a problem hiding this comment.
| .. gd_req:: Unit description | |
| .. gd_req:: Unit attribute: description |
There was a problem hiding this comment.
See above
| :satisfies: wf__sw_detailed_design[version==1] | ||
|
|
||
| Each unit shall be automatically linked (inverse direction) to the corresponding component id via the "belongs by" linkage. | ||
| Each unit shall have a description in the source code. |
There was a problem hiding this comment.
Maybe we should have to sections of process requirements. If they are selected and when we use automations and if not.
There was a problem hiding this comment.
Automation is normally with tags
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:
Diagram and Attribute Requirements:
Unit and Interface Requirements:
Work Product and Editorial Updates:
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]