Skip to content

Commit 42320a3

Browse files
committed
add document lifecylce model
Extend documentation guideline Add new process requirements Resolves: #435
1 parent 4e4138e commit 42320a3

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

process/process_areas/documentation_management/guidance/documentation_guideline.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,56 @@ For manual review of the formal elements the
3030

3131
The review of each document is done as defined for this type of work product in the respective
3232
process description.
33+
34+
35+
Document life cycle models
36+
--------------------------
37+
38+
Each official document shall have the status: “VALID”.
39+
40+
Depending on the document type (report, checklist, plan, etc.) the document can
41+
either reach this state directly, or some prior states are required.
42+
43+
Thus different document life cycle models exists:
44+
45+
* Model1: "VALID"
46+
* Model2: "DRAFT" -> "VALID"
47+
* Model3: "DRAFT" -> "VALID" -> "VALID(INSPECTED)"
48+
49+
**The document types below require life cycle model 1:**
50+
51+
Report
52+
53+
Guidance:
54+
55+
The document has the state “VALID”, if the
56+
Author has successfully done a self verification for the three aspects of content,
57+
valid structure and formal aspects.
58+
59+
**The document types below require life cycle model 2:**
60+
61+
Compare :need:`gd_req__process_management_build_blocks`, except their are part of the
62+
life cycle model 3, thus the need inspection.
63+
64+
Guidance:
65+
66+
The document has the state “DRAFT”, if the
67+
Document is created, may have no mature structure, content or formal aspects considered.
68+
Author writes the document, creates content, creates a valid structure and considers
69+
formal aspects.
70+
71+
The document has the state “VALID”, if the
72+
Document is reviewed. In this state the reviewer has successfully checked the document
73+
for content, structure and formal aspects.
74+
75+
Due to updates, findings, other issues or change request, the document status may set
76+
back from "VALID" to "DRAFT". This triggers a new review cycle.
77+
78+
**The document types below require life cycle model 3:**
79+
80+
Compare :ref:`review_concept`.
81+
82+
Guidance:
83+
84+
In principle same as life cycle model 2, but an additional inspection step is required,
85+
as described here: :ref:`review_concept`.

process/process_areas/documentation_management/guidance/documentation_process_reqs.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,21 @@ Document Management Process Requirements
6868

6969
Compare also :need:`gd_temp__documentation`
7070

71+
.. gd_req:: Document attribute: status
72+
:id: gd_req__doc_attr_status
73+
:status: valid
74+
:tags: manual_prio_1, attribute, mandatory
75+
:satisfies: wf__platform_cr_mt_platform_mgmt_plan
76+
:complies: std_req__iso26262__support_1043
77+
78+
Each document, shall have a status depending on the document life cycle models below:
79+
80+
* Model 1: VALID (e.g. for simple reports)
81+
* Model 2: DRAFT -> VALID (e.g. for plans)
82+
* Model 3: DRAFT-> VALID -> VALID(inspected) (e.g. for stakeholder requirements)
83+
84+
Compare :need:`gd_guidl__documentation`
85+
7186
.. gd_req:: Document Author
7287
:id: gd_req__doc_reviewer
7388
:status: valid

0 commit comments

Comments
 (0)