Skip to content

Commit d1e4a3d

Browse files
docs: improve req process reqs for tooling - fixes
Ref: closes #28
1 parent 4a6ad4a commit d1e4a3d

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

process/process_areas/requirements_engineering/guidance/requirements_process_reqs.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Process Requirement Attributes
5252
Each requirement shall have a unique ID. It shall consist of three parts:
5353

5454
* type of requirement
55-
* last part of the feature tree
55+
* structural element (e.g. some part of the feature tree, component acronym)
5656
* keyword describing the content of the requirement.
5757

5858
Consider the project's naming convention.
@@ -66,7 +66,7 @@ Process Requirement Attributes
6666

6767
The title of the requirement shall provide a short summary of the description, but is not an "additional" requirement.
6868

69-
This means that the word "shall" must not be used in the title for all requirements.
69+
This means for example that the word "shall" is not allowed in the title for all requirements.
7070

7171
.. gd_req:: Requirement attribute: description
7272
:id: gd_req__requirements_attr_description
@@ -139,7 +139,7 @@ Process Requirement Attributes
139139
:tags: attribute, mandatory
140140
:satisfies: wf__req__stkh_req
141141

142-
Each stakeholder requirement shall provide an attribute rationale.
142+
Each stakeholder requirement shall provide an attribute called rationale.
143143
The rationale shall contain the reason why the requirement is needed.
144144

145145
.. _process_requirement_linkage:
@@ -168,7 +168,7 @@ Process Requirement Linkage
168168
:complies: std_req__iso26262__support_6432
169169
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
170170

171-
Bi-directional traceability shall be provided by adding a "back-link" via attribute satisfied by.
171+
Bi-directional traceability shall be provided by adding a "back-link" via attribute satisfied by (i.e. make a <-> out of the <- in :need:`gd_req__req__linkage`).
172172

173173
.. gd_req:: Requirement attribute: requirement covered
174174
:id: gd_req__req__attr_req_cov
@@ -218,7 +218,7 @@ Process Requirement Linkage
218218
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
219219
:complies: std_req__iso26262__support_6425, std_req__iso26262__support_6434
220220

221-
It shall be possible to provide a versioning for requirements. For this all mandatory attributes shall be taken into account: :need:`gd_req__req__attr_mandatory`
221+
A versioning for requirements shall be provided. For this all mandatory attributes shall be taken into account: :need:`gd_req__req__attr_mandatory`
222222

223223
.. _process_requirement_checks:
224224

process/process_areas/requirements_engineering/guidance/requirements_templates.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@ Templates
9999
100100
.. tool_req:: <Title>
101101
:id: tool_req__<tool>__<Title>
102-
:reqtype: Non-Functional
103102
:security: <YES|NO>
104103
:safety: <QM|ASIL_B|ASIL_D>
105104
:satisfies: <link to process req id>
106105
:status: <valid|invalid>
106+
:implemented: <YES|PARTIAL|NO>
107107
108108
.. gd_temp:: Requirement Formulation Template
109109
:id: gd_temp__req__formulation

0 commit comments

Comments
 (0)