Skip to content

Conversation

@masc2023
Copy link
Contributor

@masc2023 masc2023 commented Dec 5, 2025

Extend documentation guideline
Add new process requirements

Resolves: #435

@github-actions
Copy link

github-actions bot commented Dec 5, 2025

The created documentation from the pull request is available at: docu-html

Copy link
Contributor

@PandaeDo PandaeDo left a 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?

@masc2023 masc2023 force-pushed the add_doc_lifecycle_model branch from 42320a3 to 64053c0 Compare December 8, 2025 06:45

**The document types below require life cycle model 3:**

Compare :ref:`review_concept`.
Copy link
Member

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.

Copy link
Contributor Author

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 ....

@RolandJentschETAS
Copy link
Contributor

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)?

@masc2023
Copy link
Contributor Author

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

@masc2023 masc2023 force-pushed the add_doc_lifecycle_model branch 3 times, most recently from 087bafe to dda5e84 Compare December 18, 2025 08:11
@masc2023 masc2023 force-pushed the add_doc_lifecycle_model branch from dda5e84 to 8348077 Compare December 18, 2025 12:10
@masc2023 masc2023 requested review from PandaeDo and pahmann December 18, 2025 12:13
Extend documentation guideline
Add new process requirements
Add document lifecycle tags

Resolves: #435
@masc2023 masc2023 force-pushed the add_doc_lifecycle_model branch from 8348077 to 3806c64 Compare December 18, 2025 14:55
Copy link
Member

@pahmann pahmann left a 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.

@PandaeDo PandaeDo merged commit 16c371b into main Dec 18, 2025
5 checks passed
@PandaeDo PandaeDo deleted the add_doc_lifecycle_model branch December 18, 2025 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improvement: Document life cycle missing

5 participants