Skip to content

Definition of detailed design #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: vohae_Impl_ML2
Choose a base branch
from
Open

Definition of detailed design #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df17664
improvements to ml2
PandaeDo Nov 13, 2025
8b6b382
Define what a unit is
PhilipPartsch Nov 24, 2025
ad5f346
Definition of the unit
PhilipPartsch Nov 24, 2025
7740748
Add Definition of a Unit
PhilipPartsch Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
920 changes: 916 additions & 4 deletions process/_assets/score_process_area_overview.drawio.svg
View file
Open in desktop
Copy link

@masc2023 masc2023 Dec 1, 2025

Choose a reason for hiding this comment

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

Needs rebase, image changed meanwhile

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions process/process_areas/implementation/guidance/implementation_process_reqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Process Requirements
:status: valid
:tags: manual_prio_1, mandatory
:satisfies: wf__sw_detailed_design
:complies: std_req__iso26262__software_843
:complies: std_req__iso26262__software_843, std_req__aspice_40__SWE-3-BP1

The static diagram shall represent the unit and their relationships using UML notations.

Expand All @@ -29,7 +29,7 @@ Process Requirements
:status: valid
:tags: manual_prio_2, mandatory
:satisfies: wf__sw_detailed_design
:complies: std_req__iso26262__software_843
:complies: std_req__iso26262__software_843, std_req__aspice_40__SWE-3-BP2

The dynamic diagram shall represent the unit and their relationships using UML notations.

Expand All @@ -38,7 +38,7 @@ Process Requirements
:status: valid
:tags: prio_1_automation, mandatory
:satisfies: wf__sw_detailed_design
:complies: std_req__iso26262__software_843
:complies: std_req__iso26262__software_843, std_req__aspice_40__SWE-3-BP3, std_req__aspice_40__SWE-3-BP4

The detailed design (units and interfaces in DD document) shall be linked
to the source code which implements the units and interfaces in the DD.
Expand Down
2 changes: 1 addition & 1 deletion process/process_areas/implementation/guidance/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Guidance
.. toctree::
:maxdepth: 1

implementation_guideline
implementation_checklist
detailed_design_template
implementation_guideline
implementation_process_reqs
software_development_template
13 changes: 9 additions & 4 deletions process/process_areas/implementation/implementation_concept.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,26 @@ The goal is to ensure that the decomposition supports **reusability** , **mainta
The detailed design and implementation should follow an **iterative approach**, allowing for
continuous improvements in quality through multiple cycles of refinement.

Specification of Detailed Design
--------------------------------
Definition of a Unit
--------------------

A **unit** is a **granular, independent entity** of a component that can be **tested separately**
during the unit testing phase. Each unit represents a **self-contained functionality** and is
derived from the decomposition of a component.

**Draft: Characteristics of a Unit**
**Characteristics of a Unit:**

- **Independent** – Can be tested in isolation.
- **Granular** – Represents a small, well-defined part of the system.
- **Relational** – Has associations with other units, defined using **UML 2.0 notations** such as
aggregation, composition, and generalization.

**Units in UML Diagrams**
**Examples:**
The definition of a unit depends on the used programming language. Examples for a unit are
a source file, a definition file (e.g. c++ header), classes, structs, and functions.
This list is not complete or exclusive.

**Units in UML Diagrams:**

- For **Rust development**, a **unit** is modeled using a **combination of `struct` and `trait`**,
as Rust does not have traditional classes.
Expand Down
4 changes: 4 additions & 0 deletions process/process_areas/implementation/implementation_roles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ Contributing Roles:

* :need:`Contributor <rl__contributor>`
* :need:`Committer <rl__committer>`

A detailed overview of the responsibility for the steps of the requirement process is listed here:

:ref:`workflow_implementation`
11 changes: 7 additions & 4 deletions process/process_areas/implementation/implementation_workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _workflow_implementation:


Workflow Implementation
#######################

Expand All @@ -26,10 +29,10 @@ Workflow Implementation
:contains: gd_temp__software_development_plan
:has: doc_concept__imp_concept, doc_getstrt__imp_getstrt

The Software Development Plan shall descirbe
- methods
- Guidelines
- development environment
The Software Development Plan shall describe
- Design and programming language selection
- Guidelines for design and coding
- Development tools

.. workflow:: Create/Maintain Implementation
:id: wf__sw_detailed_design
Expand Down
3 changes: 1 addition & 2 deletions process/process_areas/implementation/implementation_workproducts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Workproducts Implementation
:id: wp__sw_implementation
:status: valid
:tags: safety
:complies: std_wp__iso26262__software_851, std_wp__iso26262__software_852, std_wp__iso26262__software_app_c_53
:complies: std_wp__iso26262__software_851, std_wp__iso26262__software_852, std_wp__iso26262__software_app_c_53, std_req__aspice_40__iic-04-05, std_req__aspice_40__iic-11-05,

Implementation includes source code and detailed design (e.g. in form of comments or linked graphical representations) and SW configuration (e.g. #ifdef)
The "how to" is described in the SW Development Plan guidelines
Expand All @@ -43,7 +43,6 @@ Workproducts Implementation
- design guideline
- coding guideline (e.g. MISRA, can also include style guide or naming convention)
- SW configuration guideline
- Method selection (e.g. for Architecture Verification)
- development tools

.. needextend:: docname is not None and "process_areas/implementation" in docname
Expand Down
2 changes: 1 addition & 1 deletion process/process_areas/implementation/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Implementation
implementation_getstrt
implementation_concept
guidance/index
implementation_roles
implementation_workflow
implementation_workproducts
implementation_roles
_assets/detailed_design_example.rst
Loading