Skip to content

Fix issues in process requirements #121

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 1 commit into from
Jul 23, 2025
Merged

Fix issues in process requirements #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion process/process_areas/configuration_management/configuration_concept.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Key concept
The Configuration Management Plan should define the strategy to manage the configuration items
in an effective and repeatable way for the project life cycle.

Note: configuration items are all defined work products in the project plus additional arefacts not developed by the project
Note: configuration items are all realizations of defined work products in the project plus additional arefacts not developed by the project
needed for the building of the binaries, documentation and verification reports (e.g. tools, external SW libraries).

Inputs
Expand Down
4 changes: 3 additions & 1 deletion ...s/process_areas/configuration_management/guidance/configuration_process_req.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ Configuration Management Process Requirements
:tags: done_automation, config_mgt
:complies: std_req__iso26262__support_745, std_req__aspice_40__SUP-8-BP8

The structured text tool shall check that the Id's of the configuration items are unique.
The doc-as-code tool shall check that the Id's of the configuration items (documented in doc-as-code) are unique.
Copy link
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak Jul 21, 2025

Choose a reason for hiding this comment

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

This I still don't quiet understand.

Is it the needs in docs-as-code that map to the ones in doc_concept?
So ASPICE_40, ISO26262 etc.?
Or is it something else?

Copy link
Contributor Author

@aschemmel-tech aschemmel-tech Jul 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The definition in configuration_concept.rst is: "configuration items are all realizations of defined work products in the project ..." and here we say "which are documented as sphinx-needs". The work products are defined in <process_name_>workproduct.rst files.

Copy link
Contributor

@masc2023 masc2023 Jul 22, 2025

Choose a reason for hiding this comment

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

so work products are realized we the need document, having attribute realizes Process_wp_ ...., or doc_tool, they shall have all unique IDs

Copy link
Member

@AlexanderLanin AlexanderLanin Jul 22, 2025

Choose a reason for hiding this comment

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

So this applies specifically to Generic documents?

Copy link
Member

@AlexanderLanin AlexanderLanin Jul 22, 2025

Choose a reason for hiding this comment

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

Or is it the list from gd_req__config__workproducts_storage?

Copy link
Contributor Author

@aschemmel-tech aschemmel-tech Jul 22, 2025

Choose a reason for hiding this comment

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

So this applies specifically to Generic documents?

No, all work producs which are realized as needs (Requirements, Architecture, Generic Documents ...)

Copy link
Contributor Author

@aschemmel-tech aschemmel-tech Jul 22, 2025

Choose a reason for hiding this comment

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

Or is it the list from gd_req__config__workproducts_storage?

The Unique ID for files which do not contain needs, like all sources I would not consider here. For me this is the full path name. Honestly I am unsure if we should define a requirement that requires a check that checks for duplicates of SW and tools which we pull from outside the project, avoiding the use of different versions.


Note: For definition of configuration items see :need:`doc_concept__configuration__process`

.. gd_req:: Permanent Storage
:id: gd_req__config__workproducts_storage
Expand Down
52 changes: 21 additions & 31 deletions .../process_areas/documentation_management/guidance/documentation_process_reqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,19 @@ Document Management Process Requirements
:tags: manual
:complies: std_req__iso26262__support_1043

There is only one generic document type:
There are the following document types:

* document
* doc_tool

.. note::
This type is the ONLY type, which can be used for realizing concrete work products,
e.g. Safety Plan
The type "document" is the GENERIC type, which can be used for realizing concrete work products,
with the exception of the tool verification report (which uses the "doc_tool" type).
The "doc_tool" type is described in :ref:`tlm_process_requirements`.

.. note::
Process documents are not generic documents and types for that shall only used for
process definition, as defined
Process documents are not documents realizing work products,
types for that shall only used for process definition, as defined

* gd_chklst
* gd_guidl
Expand All @@ -51,7 +54,7 @@ Document Management Process Requirements
:tags: manual
:complies: std_req__iso26262__support_1043

Documents shall have the following mandatory manual attributes:
Generic documents shall have the following mandatory manual attributes:

* id
* status
Expand All @@ -64,45 +67,32 @@ Document Management Process Requirements

Compare also :need:`gd_temp__documentation`

.. gd_req:: Document attributes automated
:id: gd_req__doc__attributes_automated
:status: valid
:tags: prio_2_automation
:complies: std_req__iso26262__support_1043

Documents shall have automatic added attributes:

* author
* approver
* reviewer

.. gd_req:: Document Author
:id: gd_req__doc__author
:status: valid
:tags: prio_2_automation
:tags: prio_1_automation
:complies: std_req__iso26262__support_1045

Documents headers shall contain an "author" attribute. Every committer who adds more than 50%
of the content shall put his name.

Note: In the future this may also be automated based on an analysis of content during the
documentation build for every commit of the file containing the document.
The version management tool shall document and report (be able to show) the authorship of a document.
I.e. for each change of a document the author of the changes is stored.

.. gd_req:: Document Reviewer
:id: gd_req__doc__reviewer
:status: valid
:tags: prio_2_automation
:tags: prio_1_automation
:complies: std_req__iso26262__support_1043

Documents headers shall contain "reviewer" attribute, which is added during documentation build
and contains only the names of the last PR reviewers, which actually reviewed the file
containing the document, which were not covered by :need:`gd_req__doc__approver`.
The version management tool shall document and report (be able to show) the reviewers of a document.
I.e. for each change of a document the reviewers of the change are stored.

.. gd_req:: Document Approver
:id: gd_req__doc__approver
:status: valid
:tags: prio_2_automation
:tags: prio_1_automation
:complies: std_req__iso26262__support_1045

Documents headers shall contain an "approver" attribute, which is added during documentation build
and contains only the names of the last approval reviewers, which actually approved the file containing the document.
The version management tool shall document and report (be able to show) the approver of a document.
I.e. for each change of a document the approver of the change is stored,
which is usually the person with "write-rights" on the document approving
the merge of a Pull Request (this may also be more than one person).
Note that every approver is also reviewer.
4 changes: 3 additions & 1 deletion process/process_areas/problem_resolution/guidance/problem_resolution_reqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,14 +163,16 @@ Problem Resolution Checks
:complies: std_req__aspice_40__SUP-9-BP1

It shall be checked if all mandatory attributes for each Problem
is provided by the user. For all requirements following attributes shall be mandatory:
is provided by the user. Following attributes shall be mandatory:

.. needtable:: Overview mandatory problem attributes
:filter: "mandatory" in tags and "attribute" and "problem_resolution" in tags and is_external == False
:style: table
:columns: title
:colwidths: 30

Note: See also template for problem report: :need:`gd_temp__problem__template`

.. gd_req:: Problem Report issues closing constraints
:id: gd_req__problem__check_closing
:status: valid
Expand Down
24 changes: 12 additions & 12 deletions ...s/process_areas/requirements_engineering/guidance/requirements_process_reqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Process Requirement Linkage
.. gd_req:: Requirement Traceability
:id: gd_req__req__traceability
:status: valid
:tags: prio_1_automation
:tags: prio_1_automation, attribute
:complies: std_req__iso26262__support_6432
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req

Expand Down Expand Up @@ -216,17 +216,17 @@ Process Requirement Linkage
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
:complies: std_req__iso26262__support_6425, std_req__iso26262__support_6434

A versioning for requirements shall be provided. For this all mandatory attributes shall be taken into account: :need:`gd_req__req__attr_mandatory`
A versioning for requirements shall be provided. For this all mandatory attributes shall be taken into account: see :need:`gd_req__req__check_mandatory`

.. _process_requirement_checks:

Process Requirements Checks
'''''''''''''''''''''''''''

.. gd_req:: Requirement check: suspicious
:id: gd_req__req__attr_suspicious
:id: gd_req__req__suspicious
:status: valid
:tags: prio_2_automation, attribute
:tags: prio_2_automation, check
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
:complies: std_req__iso26262__support_6425, std_req__iso26262__support_6434

Expand All @@ -236,9 +236,9 @@ Process Requirements Checks
Note: This refers to :need:`gd_req__req__attr_req_cov` and :need:`gd_req__req__attr_test_covered`

.. gd_req:: Requirements mandatory attributes provided
:id: gd_req__req__attr_mandatory
:id: gd_req__req__check_mandatory
:status: valid
:tags: prio_1_automation, attribute, check
:tags: prio_1_automation, check
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req

It shall be checked if all mandatory attributes for each requirement is provided by the user. For all requirements following attributes shall be mandatory:
Expand All @@ -250,9 +250,9 @@ Process Requirements Checks
:colwidths: 30

.. gd_req:: Requirements no weak words
:id: gd_req__req__attr_desc_weak
:id: gd_req__req__desc_weak
:status: valid
:tags: done_automation, attribute, check
:tags: done_automation, check
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req

It shall be ensured that no *weak words* are contained in the requirement description for:
Expand All @@ -268,7 +268,7 @@ Process Requirements Checks
.. gd_req:: Requirements linkage level
:id: gd_req__req__linkage_fulfill
:status: valid
:tags: done_automation, attribute, check
:tags: done_automation, check
:complies: std_req__iso26262__support_6432
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req

Expand All @@ -279,7 +279,7 @@ Process Requirements Checks
.. gd_req:: Requirements linkage architecture
:id: gd_req__req__linkage_architecture
:status: valid
:tags: prio_2_automation, attribute, check
:tags: prio_2_automation, check
:complies: std_req__iso26262__support_6423
:satisfies: wf__req__feat_req, wf__req__comp_req

Expand All @@ -288,7 +288,7 @@ Process Requirements Checks
.. gd_req:: Requirements linkage architecture switch
:id: gd_req__req__linkage_architecture_switch
:status: valid
:tags: prio_2_automation, attribute, check
:tags: prio_2_automation, check
:complies: std_req__iso26262__support_6423
:satisfies: wf__req__feat_req, wf__req__comp_req

Expand All @@ -297,7 +297,7 @@ Process Requirements Checks
.. gd_req:: Requirements linkage safety
:id: gd_req__req__linkage_safety
:status: valid
:tags: prio_1_automation, attribute, check
:tags: prio_1_automation, check
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
:complies: std_req__iso26262__support_6422

Expand Down
2 changes: 2 additions & 0 deletions process/process_areas/requirements_engineering/requirements_concept.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ Following attributes need to be filled manually for each requirement:
* - Requirements Type
- The requirement type defines which category the requirement relates to. Following categories are defined: [Functional, Interface, Process, Legal, Non-Functional]

Following attributes are automatically generated:

.. list-table:: Automated Attributes
:header-rows: 1
:widths: 15,70,15
Expand Down
2 changes: 1 addition & 1 deletion process/process_areas/verification/guidance/verification_process_toolreqs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Test Linking to Requirements
...
}
.. gd_req:: Test Independence
.. gd_req:: Independence
:id: gd_req__verification__independence
:status: valid
:tags: done_automation, verification
Expand Down