Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ communication and documentation of architectural decisions to stakeholders.
Checklist
---------

Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additional to add in the remarks why it is passed or not passed. In case of "no" an issue link to the issue tracking system has to be added in the last column. See also :ref:`review_concept` for further information about reviews in general and inspection in particular.
Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item. Additionally, provide remarks explaining why it is passed or not passed. In case of "no", a link to the issue tracking system must be added in the last column. See also :ref:`review_concept` for further information about reviews in general and inspection in particular.

.. list-table:: Architecture Design Review Checklist
:header-rows: 1
Expand All @@ -66,94 +66,83 @@ Please note that it is mandatory to fill in the "passed" column with "yes" or "n
-
-
* - ARC_01_02
- If the architectural element is related to any supplier manuals (incl. safety and security)
are the relevant parts covered?
- If the architectural element is related to any supplier manuals (including safety and security), are the relevant parts covered?
- manual
- If the architecture makes use of supplied elements, their manuals (like safety) have to be considered (i.e. its provided functionality matches the expectation and assumptions are fulfilled). Note that in case of safety component this means that assumed Technical Safety Requirements and AoUs of the safety manual are covered.
-
-
-
* - ARC_01_03
- Is the architectural element traceable to the lower level artifacts as defined by the workproduct traceability?
- Is the architectural element traceable to the lower-level artifacts as defined by the work product traceability?
- automated
- Will be removed from checklist once the requirement (:need:`Correlations of the architectural building blocks <gd_req__arch_build_blocks_corr>`) is implemented by automated tool check. See `Tool Requirements <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html>`_.
Details of possible linking can be depicted from :ref:`traceability concept <general_concepts_traceability>`.
-
-
-
* - ARC_02_01
- Is the software architecture design compliant with the (overall) feature architecture?
- Is the software architecture design compliant with the overall feature architecture?
- manual
- On component level check against the feature architecture, on feature level check other features with common components used.
-
-
-
* - ARC_02_02
- Is appropriate and comprehensible operation/interface naming present in the architectural design?
- Is appropriate and comprehensible operation and interface naming present in the architectural design?
- manual
- Check :need:`gd_guidl__arch_design`
-
-
-
* - ARC_02_03
- Are correctness of data flow and control flow within the architectural elements considered?
- Are the correctness of data flow and control flow within the architectural elements considered?
- manual
- E.g. examine definitions, transformations, integrity, and interaction of data; check error handling, data
exchange between elements, correct response to inputs and documented decision making.
Note: consistency is ensured by the process/tooling, by defining each interface only once.
- For example, examine definitions, transformations, integrity, and interaction of data; check error handling, data exchange between elements, correct response to inputs, and documented decision making.
Note: Consistency is ensured by the process/tooling, by defining each interface only once.
-
-
-
* - ARC_02_04
- Are the interfaces between the software architectural element and other architectural elements well-defined?
- Are the interfaces between the software architectural element and other architectural elements well defined?
- manual
- Check if the interface reacts on non-defined behavior or errors; can established protocols be used; are the
interfaces for inputs, outputs, error codes documented; is loose coupling considered and only limited exposure;
can unit or integration test be written against the interface; data amount transferred; no sensitive data
exposure;
- Check if the interface handles undefined behavior or errors; can established protocols be used; are the interfaces for inputs, outputs, and error codes documented; is loose coupling considered and only limited exposure; can unit or integration tests be written against the interface; data amount transferred; ensure no sensitive data is exposed;
-
-
-
* - ARC_02_05
- Does the software architectural element consider the timing constraints (from the parent requirement)?
- manual
- If there are hard requirements on the timing a programming time estimation should be performed and also
deadline supervision considered.
- If there are strict timing requirements, a programming time estimation should be performed and deadline supervision should be considered.
-
-
-
* - ARC_02_06
- Is the documentation of the software architectural element, including textual and graphical descriptions
(e.g., UML diagrams), comprehensible and complete?
- Is the documentation of the software architectural element, including textual and graphical descriptions (e.g., UML diagrams), clear and complete?
- manual
- Use of semi-formal notation is expected for architectural elements with an allocated ASIL level.
Is the architecture template correctly filled?
- Use of semi-formal notation is expected for architectural elements with an allocated ASIL level. Is the architecture template correctly filled?
-
-
-
* - ARC_03_01
- Is the architectural element modular and encapsulated?
- manual
- Check e.g. that only minimal interfaces are used. Design should be object oriented. Interfaces and interactions are clearly defined. Usage of access types (private, protected) properly set. Limited global variables.
- Check, for example, that only minimal interfaces are used. The design should be object oriented. Interfaces and interactions are clearly defined. Usage of access types (private, protected) is properly set. Limited global variables.
-
-
-
* - ARC_03_02
- Is the suitability of the software architecture for future modifications and maintainability considered?
- manual
- Check for e.g. loose coupling, separation of concerns, high cohesion, versioning strategy for interfaces,
decision records, use of established design patterns.
- Check for, for example, loose coupling, separation of concerns, high cohesion, versioning strategy for interfaces, decision records, and use of established design patterns.
-
-
-
* - ARC_03_03
- Are simplicity and avoidance of unnecessary complexity present in the software architecture?
- manual
- Indicators for complexity are: number of use cases (corresponding to dynamic diagrams)
allocated to single design element, number of interfaces and operations in an interface,
function parameters, global variables, complex types, limited comprehensibility.
- Indicators of complexity include: the number of use cases (corresponding to dynamic diagrams) allocated to a single design element, the number of interfaces and operations in an interface, function parameters, global variables, complex types, and limited comprehensibility.

Note: If the "number" above exceeds "3" a design rationale is mandatory (for all types).
Note: If any of the numbers above exceed 3, a design rationale is mandatory (for all types).
-
-
-
Expand All @@ -165,31 +154,32 @@ Please note that it is mandatory to fill in the "passed" column with "yes" or "n
-
-
* - ARC_04_01
- If software partitioning (different operating system processes) is used to implement freedom from interference between the processes with different rating (QM/ASIL), is effectiveness evidence generated during integration and verification tests?
- If your software architectural design includes processes with different safety ratings (QM/ASIL), is freedom from interference for shared resources (CPU time, shared memory, etc.) ensured? See also ARC_04_03.

Note: see :need:`std_req__iso26262__software_749` and Annex D for partitioning
Note: see :need:`std_req__iso26262__software_7411` and :need:`std_req__iso26262__software_749` with Annex D for partitioning to ensure freedom from interference.
Note: Modules should not mix ASIL and QM processes unless justified otherwise; therefore, this question is only relevant on the feature level.
- manual
-
a) the usage of shared resources (cpu time, shared memory, ...) are checked in a way that freedom from interference between the processes is ensured,
b) check if the operating system supports freedom from interference between the processes
Also check if the operating system supports freedom from interference between the processes and make sure an "Assumption of Use requirement" for this exists in your project. For example, see `score aou_req__platform__process_isolation <https://eclipse-score.github.io/score/main/requirements/platform_assumptions/index.html#aou_req__platform__process_isolation>`_.
-
-
-
* - ARC_04_02
- Is an upper estimation of the required resources (RAM, ROM, non volatile memory, communication) available and documented?
- Does the software architectural design consider its feasibility with respect to the required resources for the embedded software, especially for time-critical aspects like startup time, but also including RAM, ROM, non-volatile memory, communication bandwidth, and processing time limits according to the requirements or foreseeable customer needs? See also ARC_02_05.

Note: see :need:`std_req__iso26262__software_7411`
Note: see :need:`std_req__iso26262__software_7413`
- manual
-
Check if there are any limits for resource consumption or timing aspects in your project, such as startup time, communication bandwidth, or memory usage. If such limits exist, ensure that your architecture takes these limits into account, especially with respect to scalability. For this, make an estimation of the required resources based on the architectural design and a prototypical implementation or a measurement of an existing implementation, and compare it to the defined limits or planned scalability. Check if any bottlenecks are present in the architecture that could lead to resource overuse or timing violations.
-
-
-
* - ARC_04_03
- Are the the scheduling properties for the component defined and documented?
- If your software architectural design includes processes and tasks, are their scheduling policies and priorities (at least the necessary relationships between them) defined to ensure that timing requirements are met? Please note that the particular priorities or priority ranges will probably be defined by the project handbook or the software development plan.

Note: see :need:`std_req__iso26262__software_743`
- manual
-
- Provide a rationale for these scheduling policies and priorities, or explain why they are not needed.
-
-
-
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,12 @@ Please note that it is mandatory to fill in the "passed" column with "yes" or "n
-
-
-
* - ARC_04_03
- If your software architectural design of the component includes processes and tasks, are their scheduling policies and priorities (at least the needed relation one to another) defined to ensure that timing requirements are met? Please note, that the particular priorities or priority ranges will be probably defined by the project handbook or the software development plan.

Note: see :need:`std_req__iso26262__software_743`
- manual
- Give a reason for these scheduling policies and priorities or explain why not needed.
-
-
-
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Platform
coverage) has to be reflected in the :need:`wp__verification_plan` and :need:`wp__platform_safety_plan`.

If software partitioning (operating system processes) is used to implement freedom from interference
effectiveness evidence shall be generated during integration and verification tests
effectiveness evidence shall be generated during integration tests.


.. workproduct:: Platform Verification Report
Expand Down Expand Up @@ -83,7 +83,7 @@ Feature
- performance and resource consumption: i.e. RAM and processor usage
on reference HW
- If software partitioning (operating system processes) is used to implement freedom from interference
effectiveness evidence shall be generated during integration and verification tests
effectiveness evidence shall be generated during integration tests.


Module
Expand Down
Loading