process introduction explanation #424
Conversation
RolandJentschETAS
requested review from
PandaeDo,
PhilipPartsch,
aschemmel-tech,
masc2023 and
pahmann
as code owners
|
The created documentation from the pull request is available at: docu-html |
process/introduction/index.rst
Outdated
|
|
||
| To facilitate onboarding and understanding, the process model provides dedicated sections for a "Getting Started", a detailed "Concept Description", and comprehensive guideline (within the "Guidance" section) for each process. These resources help Contributors, Committers and other Users quickly familiarize themselves with the process, understand key concepts, and apply best practices throughout process execution and should be read in this order. See :need:`Requirements process getting started<doc_getstrt__req_process>`, :need:`Requirement concept description<doc_concept__req_process>` and :need:`Requirement process guideline<gd_guidl__req_engineering>` as examples. | ||
|
|
||
| The model further integrates :ref:`templates<folder_templates>`, checklists (see :need:`requirement inspection checklist<doc__feature_name_req_inspection>` as example) and methods (see :need:`verification methods<gd_meth__verification_methods>` as example) to support the consistent and efficient execution of processes. |
There was a problem hiding this comment.
Guideline are also supporting according to the model
There was a problem hiding this comment.
I have it see the first sentence. "... and comprehensive guideline (within the "Guidance" section) for each process." Should I explain that more ?
There was a problem hiding this comment.
I mean only, should be moved to the next section, where methodes, etc. are mentioned, compare overview image, is part of the big box guidance
There was a problem hiding this comment.
Done. Please have a look.
| Workflows | ||
| --------- | ||
| Safety Management Workflows | ||
| ############################### |
There was a problem hiding this comment.
Align header line and text
There was a problem hiding this comment.
reverted because of parallel PR
process/process_areas/security_analysis/security_analysis_workproducts.rst
Show resolved
Hide resolved
process/process_areas/security_management/security_management_workflow.rst
Show resolved
Hide resolved
process/workproducts/index.rst
Outdated
| ============= | ||
|
|
||
| Project development work product traceability model overview: :ref:`general_concepts_traceability` | ||
| An work product (according to the term definition of the Eclipse Foundation) is an items needed as input or created as output of one or more tasks that are the responsibility of a :ref:`single role<roles>`. |
There was a problem hiding this comment.
Can you link directly to this definition?
There was a problem hiding this comment.
I have it found only in the archive: https://archive.eclipse.org/epf/downloads/OpenUP/published/openup_published_1.5.1.5_20121212/openup/core.default.uma_concept.base/guidances/termdefinitions/work_product_826E4C22.html
No idea, where this is currently.
There was a problem hiding this comment.
If not exist any more, then remove the according or link to another source
There was a problem hiding this comment.
removed the hint
process/introduction/index.rst
Outdated
|
|
||
| The process model is structured around the concept of :ref:`workflows<workflows>`, which form the core of each :ref:`process<process_areas>`. Each workflow defines the sequence of activities required to achieve specific objectives within the project. The activities linked from these workflows are directly linked to roles, ensuring that responsibilities and accountabilities are clearly assigned throughout the process. | ||
|
|
||
| Workflows also establish connections to :ref:`work products<work_products>`, which are the tangible outputs or artifacts generated during process execution. Each work product is associated with or requested by relevant :ref:`standards<external_standards>` and :ref:`requirements<process_req>` of these standards, ensuring compliance and traceability. |
There was a problem hiding this comment.
Should we also add, that work products are inputs? If yes, we may consider to adapt image also
There was a problem hiding this comment.
Yes, we should state it. Should we add another arrow in the picture or make the line with arrows and text on both sides ?
There was a problem hiding this comment.
Could be one line with arrows, as text should be the same on bot sides
PandaeDo
left a comment
PandaeDo
left a comment
There was a problem hiding this comment.
Appreciate your work. And I would like to invite you that we discuss it next time on Thursday meeting. Then we can have a short alignment on what shall be changed and maybe we can also plan and/or add some other things that shall be improved in the documentation.
process/process_areas/security_analysis/security_analysis_workproducts.rst
Show resolved
Hide resolved
Signed-off-by: RolandJentschETAS <135332348+RolandJentschETAS@users.noreply.github.com>
process/process_areas/architecture_design/architecture_workproducts.rst
Outdated
Show resolved
Hide resolved
process/process_areas/requirements_engineering/requirements_workproducts.rst
Outdated
Show resolved
Hide resolved
masc2023
left a comment
masc2023
left a comment
There was a problem hiding this comment.
There are still open comments. Can we add a link to an issue, that Safety Management needs still formal rework, so then it is also clear for the reader, that this chapter is not finalized yet?
3 participants
Add explanation of process model into introduction and link it.
See Improvement: Proper workflow description #236
.
Option A: Describe this in the needs workflow descriptions of every process area.
Option B: Describe what to find where in a central place like "Introduction"
decided in process meeting to have a mixture of options A and B: decribe the approach to understand the processes in https://eclipse-score.github.io/process_description/main/introduction/index.html (B) and also add links to this (and probably links to the detailed describtion of workflow steps) in the workflow description. Roland to create a PR to fix this for architecture and present in the community.