Skip to content
Merged
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
11 changes: 10 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,14 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"bazel.lsp.command": "bazel",
"bazel.lsp.args": ["run", "//:starpls_server"]
"bazel.lsp.args": [
"run",
"//:starpls_server"
],
"cSpell.words": [
"docname",
"needarch",
"toctree",
"workproduct"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Please note that it is mandatory to fill in the "passed" column with "yes" or "n
* - ARC_02_04
- Are the interfaces between the software architectural element and other architectural elements well defined?
- manual
- 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;
- Check if the interface handles undefined behaviour 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;
-
-
-
Expand Down
2 changes: 1 addition & 1 deletion process/folder_templates/features/feature_name/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ How to Teach This
[How to teach users, new and experienced, how to apply the CR to their work.]

.. note::
For a CR that adds new functionality or changes behavior, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work.
For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Safety Work products List
.. attention::
The above table must be updated according to your feature safety planning.

- Fill the work producs links
- Fill the work products links

Feature Safety Package
======================
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Please note that it is mandatory to fill in the "passed" column with "yes" or "n
* - ARC_02_04
- 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
- Check if the interface reacts on non-defined behaviour 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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ How to Teach This
[How to teach users, new and experienced, how to apply the CR to their work.]

.. note::
For a CR that adds new functionality or changes behavior, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work.
For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work.

Rejected Ideas
==============
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ See :ref:`uml_diagram_selection` in guideline for further information about the
Dynamic View
------------

This view shows the *dynamic behavior* of the feature including the interaction of its components with the user. Following scenarios should be included:
This view shows the *dynamic behaviour* of the feature including the interaction of its components with the user. Following scenarios should be included:

* important use cases or features: how do components execute them?
* interactions at critical external interfaces: how do components cooperate with users and neighboring components?
Expand Down Expand Up @@ -309,9 +309,9 @@ To represent the CI build tool module (for example a `Bazel Modules <https://baz
Dynamic view
============

The *dynamic view* describes the concrete behavior and interactions of the *building blocks* in form of use cases which were described above.
The *dynamic view* describes the concrete behaviour and interactions of the *building blocks* in form of use cases which were described above.

The dynamic view shall be modeled partly in Sphinx Needs and PlantUML. The components itself shall be used from the sphinx needs model in the PlantUML diagram. The dynamic relations between the component and the interfaces shall be modeled in PlantUML as it would be a huge effort to model the dynamic behavior in sphinx needs and would not provide any additional benefit.
The dynamic view shall be modeled partly in Sphinx Needs and PlantUML. The components itself shall be used from the sphinx needs model in the PlantUML diagram. The dynamic relations between the component and the interfaces shall be modeled in PlantUML as it would be a huge effort to model the dynamic behaviour in sphinx needs and would not provide any additional benefit.

.. list-table:: Definition of the dynamic architectural elements
:header-rows: 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,8 @@ Module Viewpoint

{{ draw_module(need(), needs) }}

Component Architecure File(s)
=============================
Component Architecture File(s)
==============================

.. comp:: Component 1
:id: comp__component_example_1
Expand Down Expand Up @@ -254,7 +254,7 @@ Component Architecure File(s)
:safety: ASIL_B
:security: NO

Requierements for the Example
Requirements for the Example
=============================

.. Requirements
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,15 +115,15 @@ the detailed design.
Dynamic View
````````````
The **dynamic view** illustrates how the **units** interact with each other over **interfaces** to fulfill a specific
**use case** or **functionality**. This view captures the **behavioral aspects** of the component as it executes.
It is represented using **UML behavioral diagrams**, including:
**use case** or **functionality**. This view captures the **behavioural aspects** of the component as it executes.
It is represented using **UML behavioural diagrams**, including:

- **Sequence Diagrams** – Depict the interactions between objects in a **time-ordered sequence**,
highlighting how methods are invoked and how control flows between objects over time.
- **State Machine Diagrams** – Show how the **state of an object changes** in response to events,
allowing for the modeling of complex state transitions (if there is stateful behaviour).

These diagrams are essential for understanding the **dynamic behavior** of the component and how
These diagrams are essential for understanding the **dynamic behaviour** of the component and how
units collaborate to perform tasks. But this also means that if the dynamic behaviour is simple
it does not require a dynamic diagram at all (similar to the rules depicted in :need:`gd_guidl__arch_design`).

Expand Down Expand Up @@ -261,4 +261,3 @@ The following section provides templates for defining needs within the source co
//! :implements: <real_arc_int, real_arc_int_op>
//!
//! This implements the ....

Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Problem Attributes
problem.

.. gd_req:: Problem attribute: analysis results
:id: gd_req__problem_attr_anaylsis_results
:id: gd_req__problem_attr_analysis_results
:status: valid
:tags: manual_prio_1, problem_resolution, attribute, mandatory
:satisfies: wf__problem_create_pr, wf__problem_analyze_pr, wf__problem_initiate_monitor_pr, wf__problem_close_pr
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ For a detailed explanation of workflows and their role within the process model,

The Problem Resolution is implemented and monitored.

This may require Change Requests or other activities, inlcuding creating ISSUEs and PRs.
This may require Change Requests or other activities, including creating ISSUEs and PRs.
These are linked to the Problem and monitored until closure.

The Problem Resolution is done, if all linked activities has been closed and confirmed.
Before closing the Problem Resoultion, :need:`Committer <rl__committer>` must check the
Before closing the Problem Resolution, :need:`Committer <rl__committer>` must check the
correctness.

The :need:`Committer <rl__committer>` may still reject it, thus the status is set to "rejected".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ i.e. the assumption on what content is needed, which shall be matched by the use
Feature Requirements
====================

The *Feature Requirements* derived from stakeholder requirements address mainly the integration level of SW modules and components. These shall describe the behavior of the feature on platform level shall be described including the correlations of the integrated components. They serves mainly as an input for (SW + Safety) Architects, Testers, Integrators and are derived from the *Stakeholder Requirements*. To provide an example
The *Feature Requirements* derived from stakeholder requirements address mainly the integration level of SW modules and components. These shall describe the behaviour of the feature on platform level shall be described including the correlations of the integrated components. They serves mainly as an input for (SW + Safety) Architects, Testers, Integrators and are derived from the *Stakeholder Requirements*. To provide an example

.. code-block:: text

Expand All @@ -124,7 +124,7 @@ However the detailed interaction of the underlying components itself which is re
Component Requirements
======================

The lowest abstraction level is represented by the *component requirements*. They are derived from *feature requirements* and describe component specific implementation details. It is described which behavior a component itself needs to fulfil in the context of the feature, e.g.
The lowest abstraction level is represented by the *component requirements*. They are derived from *feature requirements* and describe component specific implementation details. It is described which behaviour a component itself needs to fulfil in the context of the feature, e.g.

.. code-block:: text

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ The Safety Analysis (DFA and FMEA) shall consider the architectural elements on

1. **Platform Level**: At this level, the focus is on the overall feature architecture to analyse if there are failures that effects more than one feature.

| **Example DFA:** Dependencies between features shall be analysed. This could be the usage of modules by different features, shared libraries or shared services. A common cause failure could be a erroneous signal that effects the behavior of several functions.
| **Example DFA:** Dependencies between features shall be analysed. This could be the usage of modules by different features, shared libraries or shared services. A common cause failure could be a erroneous signal that effects the behaviour of several functions.

2. **Feature Level**: This level involves a more detailed analysis of individual components within the feature. The analysis shall consider the internal structure of components and their interactions with other components in the feature.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ Stakeholders

* Main responsible to ensure ISO 26262 compliance in the project
* Create/Maintain Safety Plan
* Perform Formal Reviews (for safety work products not in his resposibility area)
* Perform Formal Reviews (for safety work products not in his responsibility area)
* Approve Component Classification
* Approve Safety Package
* Approve Safety Audit
* Approve Formal Reviews (for safety work products in his resposibility area)
* Approve Formal Reviews (for safety work products in his responsibility area)
* Approve Safety Manual
* Monitor/Verify Safety
* Impact Analysis of Change Request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ The following perspectives are included in ``equivalence-classes``:
- **Improve Test Coverage**

By testing at least one value from each partition, you ensure that you've covered all the
different behaviors of the software.
different behaviours of the software.
- **Address Different Input Types**

EP is applicable to various input types, including numerical ranges, enumerated values,
Expand Down Expand Up @@ -298,7 +298,7 @@ How to perform the analysis:
Classes that contain invalid input values (out of range, incorrect data type, etc.).
- **Special Cases**

Classes representing specific or unusual input values that might trigger special behavior
Classes representing specific or unusual input values that might trigger special behaviour
in the software.

**3. Define Test Values**
Expand All @@ -324,7 +324,7 @@ Fuzzy Testing
Fuzzy Testing, often called Fuzz Testing, is a software testing technique that involves providing
invalid, unexpected, or random data as inputs to a component or system to detect defects. The goal
of fuzzy testing is to expose unhandled exceptions, memory leaks, assertion failures, and other
critical issues by generating semi-random inputs and observing the system's behavior.
critical issues by generating semi-random inputs and observing the system's behaviour.

The following perspectives are included in ``fuzz-testing``:

Expand Down Expand Up @@ -359,8 +359,8 @@ How to perform fuzzy testing:
**3. Generate Fuzzy Inputs** Create inputs that are slightly malformed or unexpected, either
through complete randomization or by mutating valid inputs.

**4. Monitor System Behavior** Execute the system with fuzzy inputs and monitor for crashes,
hangs, memory leaks, or other unexpected behaviors.
**4. Monitor System behaviour** Execute the system with fuzzy inputs and monitor for crashes,
hangs, memory leaks, or other unexpected behaviours.

**5. Analyze and Fix Issues** When a problem is detected, analyze the input that caused it
and fix the underlying issue in the code.
4 changes: 2 additions & 2 deletions process/process_areas/verification/verification_concept.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,10 @@ tests or component tests. This linking is done using metatags. This is also true
integration tests linking to the component requirements and architecture.

Traceability of feature integration tests shall be established through linking those test cases to
feature requirements and architecture as features describe the integrated behavior of all components.
feature requirements and architecture as features describe the integrated behaviour of all components.

Traceability of platform integration tests shall be established through linking those test cases to
stakeholder requirements as stakeholder requirements describe the platform behavior.
stakeholder requirements as stakeholder requirements describe the platform behaviour.

Note that all the above tests shall only link to requirements of type "Functional" and "Interface".
The verification of requirements of types "Process" and "Non-Functional" will be done via Analysis,
Expand Down
4 changes: 2 additions & 2 deletions process/standards/aspice_40/iic/iic-17.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,5 +114,5 @@
Needs are derived from Work Breakdown structure and schedule


.. needextend:: "c.this_doc()"
:+tags: aspice40_iic17
.. needextend:: "c.this_doc()"
:+tags: aspice40_iic17
4 changes: 2 additions & 2 deletions process/standards/aspice_40/swe/swe.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,5 +137,5 @@ Base practices
architecture to all affected parties.


.. needextend:: "c.this_doc()"
:+tags: aspice40_swe2
.. needextend:: "c.this_doc()"
:+tags: aspice40_swe2
2 changes: 1 addition & 1 deletion process/standards/iso26262/iso26262.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1351,7 +1351,7 @@ Part 8: Supporting processes
:status: valid


.. std_wp:: support_8522
.. std_wp:: support_852
:id: std_wp__iso26262__support_852
:status: valid

Expand Down