-
Notifications
You must be signed in to change notification settings - Fork 16
add document lifecylce model #436
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.
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
Conversation
|
The created documentation from the pull request is available at: docu-html |
PandaeDo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please also update the Documentation Management Plan?
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Outdated
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Show resolved
Hide resolved
42320a3 to
64053c0
Compare
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Outdated
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Outdated
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Outdated
Show resolved
Hide resolved
|
|
||
| **The document types below require life cycle model 3:** | ||
|
|
||
| Compare :ref:`review_concept`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what I should extract from this link as a comparison as it links to a concept not to a list of docment types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed is there a table only with inspected work products, just scroll down
inspected work product Id ....
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Outdated
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Outdated
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_guideline.rst
Outdated
Show resolved
Hide resolved
process/process_areas/documentation_management/guidance/documentation_process_reqs.rst
Outdated
Show resolved
Hide resolved
|
Because any review have to be documented for later safety audits and for analysis of field issues, is there any process requirement, that document reviews and review discussions / participants have to be stored for the whole lifetime of the product (>10 years)? |
This is considered already during past audits, as part of Github, REviews, etc. but there are work products, which may not require reviews at all. So first step is to identify, which document types we have and then we can see, if Lifecycle model 1 is required or not |
087bafe to
dda5e84
Compare
dda5e84 to
8348077
Compare
Extend documentation guideline Add new process requirements Add document lifecycle tags Resolves: #435
8348077 to
3806c64
Compare
pahmann
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reviewed the changes, but can really better track the changes with multiple commits and not always the force push to keep a single commit in a PR. I know the history remains, but I have to search much longer and compare potentially several force pushes.
It is common practice for many projects to have a commit history on the PR and do force pushes only for non-reviewed code. We can always squash and merge at the end.
Maybe we can discuss this beginning of next year in a process community meeting. Especially, in case many files are changed addressing review findings over time helps which is harder with the force-pushes.
Extend documentation guideline
Add new process requirements
Resolves: #435