Skip to content

Improvement: Process requirements alignment #99

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

Merged
aschemmel-tech merged 2 commits into from
Jul 10, 2025
Merged

Improvement: Process requirements alignment #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c0c0e9
Improvement: Process requirements alignment
aschemmel-tech Jul 3, 2025
76f5db9
Process requirements alignment - review fixes
aschemmel-tech Jul 8, 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
50 changes: 33 additions & 17 deletions process/general_concepts/score_review_concept.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,32 +153,38 @@ shall transition from "valid(inspected)" back to "valid" state. This shall be au
Process Requirements
^^^^^^^^^^^^^^^^^^^^

.. gd_req:: Storage of pull requests documentation
:id: gd_req__general__pull_request_storage
.. gd_req:: Version for inspected requirements
:id: gd_req__general__requirements_version
:status: valid
:tags: prio_1_automation, general
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
:satisfies: wf__monitor_verify_requirements

The content of pull requests (conversation, commits, files changed) shall be stored permanently
for every release.
The version of a requirement shall not change by an inspection.

Note: Expectation is that this should be part of configuration management, but as this process
is not defined at the moment this requirement is added here.
This means: In case the status of the requirement (see :need:`gd_req__req__attr_status`)
is used to notify if a requirement is inspected (or another attribute is introduced),
this shall be ignored for versioning.

.. gd_req:: Hash value for inspected requirements
:id: gd_req__general__requirements_hash
:status: valid
.. gd_req:: Version for inspected architecture
:id: gd_req__general__architecture_version
:status: draft
:tags: general
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
:satisfies: wf__mr_vy_arch

The version of architecture element shall not change by an inspection.

This means: In case the status of the element (see :need:`gd_req__arch__attr_status`)
is used to notify if it is inspected (or another attribute is introduced),
this shall be ignored for versioning.

The hash value of a requirement shall not change by an inspection. In case the status of the
requirement is used to notify if a requirement is inspected (or another attribute is introduced),
this shall be ignored for hashing (i.e. hash value for valid and valid(inspected) shall be equal).
In case hashing is also used for architecture versioning this shall be done in similar way.
Note: this applies only if architecture also has a version.

.. gd_req:: Checklist templates in pull requests
:id: gd_req__general__checklist_templates
:status: valid
:tags: prio_2_automation, general
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414, std_req__iso26262__software_942
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch

Expand All @@ -187,10 +193,20 @@ Process Requirements
Ideally this is automatically applied based on the files modified in the PR.
The requirements and architecture inspections are not automatically applied.

.. gd_req:: Status Check
:id: gd_req__general__status_check
.. gd_req:: Status Set Check
:id: gd_req__general__status_set_check
:status: valid
:tags: prio_2_automation, general
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch

It shall be checked that only a PR with the inspection checklist filled out can set a status to valid(inspected).

.. gd_req:: Status Reset Check
:id: gd_req__general__status_reset_check
:status: valid
:tags: prio_2_automation, general
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch

It shall be checked that the status is reset to valid whenever a requirement is modified (changes version).
55 changes: 31 additions & 24 deletions process/process_areas/architecture_design/guidance/architecture_process_reqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Architectural Model
.. gd_req:: Architecture Modeling
:id: gd_req__arch__model
:status: valid
:tags: manual
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
:satisfies: wf__cr_mt_featarch

Expand All @@ -31,6 +32,7 @@ Architectural Model
.. gd_req:: Hierarchical structure of architectural elements
:id: gd_req__arch__hierarchical_structure
:status: valid
:tags: done_automation
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
:satisfies: wf__cr_mt_featarch

Expand All @@ -42,24 +44,26 @@ Architectural Model
.. gd_req:: Structuring of the architectural elements
:id: gd_req__arch__build_blocks
:status: valid
:tags: done_automation
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
:satisfies: wf__cr_mt_featarch

Following architectural elements shall be defined on the respective hierarchical level:

* Logical Level
* Feature (logic_arc_sta)
* Feature (feature_arc_sta)
* Logical Interface (logic_arc_int)
* Logical Interface Operation (logic_arc_int_op)

* Component Level
* Component (comp_arc_sta)
* Interface (comp_arc_int)
* Interface Operation (comp_arc_int_op)
* Interface (real_arc_int)
* Interface Operation (real_arc_int_op)

.. gd_req:: Correlations of the architectural building blocks
:id: gd_req__arch__build_blocks_corr
:status: valid
:tags: done_automation
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
:satisfies: wf__cr_mt_featarch

Expand All @@ -76,14 +80,15 @@ Architectural Views
.. gd_req:: Architecture Viewpoints
:id: gd_req__arch__viewpoints
:status: valid
:tags: manual
:complies: std_req__iso26262__support_6432, std_req__iso26262__software_742
:satisfies: wf__cr_mt_featarch

The architecture shall be shown on following views on each architectural level:

* Package Diagram (logic_arc_sta, comp_arc_sta)
* Sequence Diagram (logic_arc_dyn, comp_arc_dyn)
* Interface View (logic_arc_int, comp_arc_int)
* Package Diagram (feat_arc_sta, comp_arc_sta)
* Sequence Diagram (feat_arc_dyn, comp_arc_dyn)
* Interface View (logic_arc_int, real_arc_int)

Only an additional view shall be created on module level.

Expand All @@ -93,7 +98,7 @@ Attributes of Architectural Elements
.. gd_req:: Architecture attribute: UID
:id: gd_req__arch__attribute_uid
:status: valid
:tags: attribute,mandatory
:tags: manual, attribute, mandatory
:complies: std_req__iso26262__support_6425, std_req__iso26262__support_6432

Each architectural element shall have a unique ID. It shall be in a format which is also human readable and consists of
Expand All @@ -102,12 +107,12 @@ Attributes of Architectural Elements
* structural element (e.g. some part of the feature tree, component acronym)
* keyword describing the content of the architectural element

The naming convention is defined here: `REPLACE_doc__naming_conventions`
Check your project's naming conventions (should be called "doc__naming_conventions")

.. gd_req:: Architecture attribute: security
:id: gd_req__arch_attr_security
:id: gd_req__arch__attr_security
:status: valid
:tags: attribute, mandatory
:tags: manual, attribute, mandatory

Each architectural element shall have a security relevance identifier:

Expand All @@ -117,7 +122,7 @@ Attributes of Architectural Elements
.. gd_req:: Architecture attribute: safety
:id: gd_req__arch__attr_safety
:status: valid
:tags: attribute, mandatory
:tags: manual, attribute, mandatory
:complies: std_req__iso26262__support_6421, std_req__iso26262__support_6425

Each architectural element shall have a automotive safety integrity level (ASIL) identifier:
Expand All @@ -129,7 +134,7 @@ Attributes of Architectural Elements
.. gd_req:: Architecture attribute: status
:id: gd_req__arch__attr_status
:status: valid
:tags: attribute, mandatory
:tags: manual, attribute, mandatory
:complies: std_req__iso26262__support_6425

Each architectural element shall have a status:
Expand All @@ -143,15 +148,15 @@ Traceability to Requirements
.. gd_req:: Architecture attribute: fulfils
:id: gd_req__arch__attr_fulfils
:status: valid
:tags: attribute, mandatory
:tags: manual, attribute, mandatory
:complies: std_req__iso26262__support_6425

Each architectural element shall be linked to a requirement.

.. gd_req:: Architecture traceability
:id: gd_req__arch__traceability
:status: valid
:tags: architecture_design
:tags: manual
:complies: std_req__iso26262__support_6432
:satisfies: wf__cr_mt_featarch

Expand All @@ -171,7 +176,7 @@ Checks for Architectural Design
.. gd_req:: Architecture mandatory attributes
:id: gd_req__arch__attr_mandatory
:status: valid
:tags: attribute, check
:tags: prio_1_automation, attribute, check

It shall be checked if all mandatory attributes for each architectural element are provided by the user. For all elements following attributes shall be mandatory:

Expand All @@ -184,65 +189,67 @@ Checks for Architectural Design
.. gd_req:: Architecture linkage metamodel
:id: gd_req__arch__linkage_safety
:status: valid
:tags: attribute, check
:tags: prio_1_automation, attribute, check

It shall be checked that every valid safety architectural element is linked according to the defined model :need:`gd_req__arch__build_blocks_corr`.

.. gd_req:: Architecture linkage safety
:id: gd_req__arch__linkage_safety_trace
:status: valid
:tags: attribute, check
:tags: prio_1_automation, attribute, check

It shall be checked that valid safety architectural elements (Safety != QM) can only be linked against valid safety architectural elements.

.. gd_req:: Architecture linkage security
:id: gd_req__arch__linkage_security_trace
:status: valid
:tags: attribute, check
:tags: prio_2_automation, attribute, check

It shall be checked that security relevant architectural elements (Security == YES) can only be linked against security relevant architectural elements.

.. gd_req:: Architecture linkage requirement
:id: gd_req__arch__linkage_requirement
:status: valid
:tags: attribute, check
:tags: prio_1_automation, attribute, check

It shall be checked that each architectural element (safety!=QM) is linked against at least one safety requirement (safety!=QM).
It shall be checked that architectural elements with safety=QM are not linked against safety requirements (safety!=QM).

.. gd_req:: Architecture linkage requirement type
:id: gd_req__arch__linkage_requirement_type
:status: valid
:tags: attribute, check
:tags: prio_3_automation, attribute, check

It shall be checked that requirements of a respective type can only be linked to architectural elements according to following traceability:

* Functional requirements <-> static / dynamic architectural elements (logic_arc_sta, logic_arc_dyn)
* Functional requirements <-> static / dynamic architectural elements (feat_arc_sta, feat_arc_dyn)
* Interface requirements <-> interface architectural elements (logic_arc_int, logic_arc_int_op)

.. gd_req:: Architecture check consistency modules
:id: gd_req__arch__consistency_model
:status: valid
:tags: model, check
:tags: prio_2_automation, model, check

It shall be checked if all mentioned SW components are available in the modules repository.

.. gd_req:: Architecture check consistency interfaces
:id: gd_req__arch__consistency_interf
:status: valid
:tags: model, check
:tags: prio_2_automation, model, check

It shall be checked if all mentioned component interfaces are available in the modules repository.

.. gd_req:: Architecture check consistency dynamic architecture
:id: gd_req__arch__consistency_dynamic
:status: valid
:tags: model, check
:tags: prio_3_automation, model, check

It shall be checked if all SW components which are mentioned in the dynamic architecture are defined in the static architecture.

.. gd_req:: Building Blocks Dynamic Architecture
:id: gd_req__arch__build_blocks_dynamic
:status: valid
:tags: done_automation
:satisfies: wf__cr_mt_featarch

It shall be possible to provide the required architectural building blocks inside the dynamic architecture.
4 changes: 2 additions & 2 deletions process/process_areas/change_management/change_management_workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Workflow Change Management
:supported_by: rl__technical_lead, rl__module_lead
:input: wp__policies, wp__issue_track_system, wp__feat_request, wp__cmpt_request
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change_tool_impact_analysis
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change__tool_impact_analysis
:has: doc_concept__change__process, doc_getstrt__change__process

The Change Request is created and analyzed.
Expand All @@ -49,7 +49,7 @@ Workflow Change Management
:supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
:input: wp__issue_track_system, wp__feat_request, wp__cmpt_request
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change_tool_impact_analysis
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change__tool_impact_analysis
:has: doc_concept__change__process, doc_getstrt__change__process

The Change Request is evaluated based on the analysis result either approved, rejected or delayed.
Expand Down
Loading