Skip to content

Commit e6aaa88

Browse files
Fix issues in process requirements
Ref: Resolves #117
1 parent cc48423 commit e6aaa88

7 files changed

Lines changed: 38 additions & 28 deletions

File tree

process/process_areas/configuration_management/configuration_concept.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Key concept
2828
The Configuration Management Plan should define the strategy to manage the configuration items
2929
in an effective and repeatable way for the project life cycle.
3030

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

3434
Inputs

process/process_areas/configuration_management/guidance/configuration_process_req.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ Configuration Management Process Requirements
2121
:tags: done_automation, config_mgt
2222
:complies: std_req__iso26262__support_745, std_req__aspice_40__SUP-8-BP8
2323

24-
The structured text tool shall check that the Id's of the configuration items are unique.
24+
The doc-as-code tool shall check that the Id's of the configuration items (documented in doc-as-code) are unique.
25+
26+
Note: For definition of configuration items see :need:`doc_concept__configuration__process`
2527

2628
.. gd_req:: Permanent Storage
2729
:id: gd_req__config__workproducts_storage

process/process_areas/documentation_management/guidance/documentation_process_reqs.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,19 @@ Document Management Process Requirements
2323
:tags: manual
2424
:complies: std_req__iso26262__support_1043
2525

26-
There is only one generic document type:
26+
There are the following document types:
27+
2728
* document
29+
* doc_tool
2830

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

3336
.. note::
34-
Process documents are not generic documents and types for that shall only used for
35-
process definition, as defined
37+
Process documents are not documents realizing work products,
38+
types for that shall only used for process definition, as defined
3639

3740
* gd_chklst
3841
* gd_guidl
@@ -51,7 +54,7 @@ Document Management Process Requirements
5154
:tags: manual
5255
:complies: std_req__iso26262__support_1043
5356

54-
Documents shall have the following mandatory manual attributes:
57+
Generic documents shall have the following mandatory manual attributes:
5558

5659
* id
5760
* status
@@ -70,7 +73,7 @@ Document Management Process Requirements
7073
:tags: prio_2_automation
7174
:complies: std_req__iso26262__support_1043
7275

73-
Documents shall have automatic added attributes:
76+
Generic documents shall have automatic added attributes:
7477

7578
* author
7679
* approver
@@ -82,10 +85,11 @@ Document Management Process Requirements
8285
:tags: prio_2_automation
8386
:complies: std_req__iso26262__support_1045
8487

85-
Documents headers shall contain an "author" attribute. Every committer who adds more than 50%
86-
of the content shall put his name.
88+
Generic documents headers shall contain an "author" attribute which is filled with the
89+
committer/contributor name(s) who added/modified most lines in the document (more than one name in case of same numbers).
90+
Plus the name of the person doing the last commit, if different from the before.
8791

88-
Note: In the future this may also be automated based on an analysis of content during the
92+
Note: This should be automated based on an analysis of content during the
8993
documentation build for every commit of the file containing the document.
9094

9195
.. gd_req:: Document Reviewer
@@ -94,7 +98,7 @@ Document Management Process Requirements
9498
:tags: prio_2_automation
9599
:complies: std_req__iso26262__support_1043
96100

97-
Documents headers shall contain "reviewer" attribute, which is added during documentation build
101+
Generic documents headers shall contain "reviewer" attribute, which is added during documentation build
98102
and contains only the names of the last PR reviewers, which actually reviewed the file
99103
containing the document, which were not covered by :need:`gd_req__doc__approver`.
100104

@@ -104,5 +108,5 @@ Document Management Process Requirements
104108
:tags: prio_2_automation
105109
:complies: std_req__iso26262__support_1045
106110

107-
Documents headers shall contain an "approver" attribute, which is added during documentation build
111+
Generic documents headers shall contain an "approver" attribute, which is added during documentation build
108112
and contains only the names of the last approval reviewers, which actually approved the file containing the document.

process/process_areas/problem_resolution/guidance/problem_resolution_reqs.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,16 @@ Problem Resolution Checks
163163
:complies: std_req__aspice_40__SUP-9-BP1
164164

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

168168
.. needtable:: Overview mandatory problem attributes
169169
:filter: "mandatory" in tags and "attribute" and "problem_resolution" in tags and is_external == False
170170
:style: table
171171
:columns: title
172172
:colwidths: 30
173173

174+
Note: See also template for problem report: :need:`gd_temp__problem__template`
175+
174176
.. gd_req:: Problem Report issues closing constraints
175177
:id: gd_req__problem__check_closing
176178
:status: valid

process/process_areas/requirements_engineering/guidance/requirements_process_reqs.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Process Requirement Linkage
162162
.. gd_req:: Requirement Traceability
163163
:id: gd_req__req__traceability
164164
:status: valid
165-
:tags: prio_1_automation
165+
:tags: prio_1_automation, attribute
166166
:complies: std_req__iso26262__support_6432
167167
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
168168

@@ -216,17 +216,17 @@ Process Requirement Linkage
216216
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
217217
:complies: std_req__iso26262__support_6425, std_req__iso26262__support_6434
218218

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

221221
.. _process_requirement_checks:
222222

223223
Process Requirements Checks
224224
'''''''''''''''''''''''''''
225225

226226
.. gd_req:: Requirement check: suspicious
227-
:id: gd_req__req__attr_suspicious
227+
:id: gd_req__req__suspicious
228228
:status: valid
229-
:tags: prio_2_automation, attribute
229+
:tags: prio_2_automation, check
230230
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
231231
:complies: std_req__iso26262__support_6425, std_req__iso26262__support_6434
232232

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

238238
.. gd_req:: Requirements mandatory attributes provided
239-
:id: gd_req__req__attr_mandatory
239+
:id: gd_req__req__check_mandatory
240240
:status: valid
241-
:tags: prio_1_automation, attribute, check
241+
:tags: prio_1_automation, check
242242
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
243243

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

252252
.. gd_req:: Requirements no weak words
253-
:id: gd_req__req__attr_desc_weak
253+
:id: gd_req__req__desc_weak
254254
:status: valid
255-
:tags: done_automation, attribute, check
255+
:tags: done_automation, check
256256
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
257257

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

@@ -279,7 +279,7 @@ Process Requirements Checks
279279
.. gd_req:: Requirements linkage architecture
280280
:id: gd_req__req__linkage_architecture
281281
:status: valid
282-
:tags: prio_2_automation, attribute, check
282+
:tags: prio_2_automation, check
283283
:complies: std_req__iso26262__support_6423
284284
:satisfies: wf__req__feat_req, wf__req__comp_req
285285

@@ -288,7 +288,7 @@ Process Requirements Checks
288288
.. gd_req:: Requirements linkage architecture switch
289289
:id: gd_req__req__linkage_architecture_switch
290290
:status: valid
291-
:tags: prio_2_automation, attribute, check
291+
:tags: prio_2_automation, check
292292
:complies: std_req__iso26262__support_6423
293293
:satisfies: wf__req__feat_req, wf__req__comp_req
294294

@@ -297,7 +297,7 @@ Process Requirements Checks
297297
.. gd_req:: Requirements linkage safety
298298
:id: gd_req__req__linkage_safety
299299
:status: valid
300-
:tags: prio_1_automation, attribute, check
300+
:tags: prio_1_automation, check
301301
:satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
302302
:complies: std_req__iso26262__support_6422
303303

process/process_areas/requirements_engineering/requirements_concept.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,8 @@ Following attributes need to be filled manually for each requirement:
183183
* - Requirements Type
184184
- The requirement type defines which category the requirement relates to. Following categories are defined: [Functional, Interface, Process, Legal, Non-Functional]
185185

186+
Following attributes are automatically generated:
187+
186188
.. list-table:: Automated Attributes
187189
:header-rows: 1
188190
:widths: 15,70,15

process/process_areas/verification/guidance/verification_process_toolreqs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Test Linking to Requirements
124124
...
125125
}
126126
127-
.. gd_req:: Test Independence
127+
.. gd_req:: Independence
128128
:id: gd_req__verification__independence
129129
:status: valid
130130
:tags: done_automation, verification

0 commit comments

Comments
 (0)