Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Architecture Work Products
.. workproduct:: Feature Architecture
:id: wp__feature_arch
:status: valid
:complies: std_wp__iso26262__software_751, std_wp__isosae21434__development_1051
:complies: std_wp__iso26262__software_751
:tags: doc_lifecycle_model_3

Feature Architecture linked to Feature Requirements, i.e. interaction of components

Expand All @@ -33,7 +34,8 @@ Architecture Work Products
.. workproduct:: Component Architecture
:id: wp__component_arch
:status: valid
:complies: std_wp__iso26262__software_751, std_wp__isopas8926__4523, std_wp__isosae21434__development_1051
:complies: std_wp__iso26262__software_751, std_wp__isopas8926__4523
:tags: doc_lifecycle_model_3

Component Architecture linked to Component Requirements

Expand All @@ -47,6 +49,7 @@ Architecture Work Products
:id: wp__sw_arch_verification
:status: valid
:complies: std_wp__iso26262__software_754
:tags: doc_lifecycle_model_2

Depends on architecture guideline and tooling.
May include several methods like inspection, modelling ... Which are selected in SW Verification Plan.
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,16 @@ Change Management Work Products
.. workproduct:: Platform Change Management Plan
:id: wp__chm_plan
:status: valid
:tags: change_management
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__support_851

Change Management Plan (Part of the Platform Management Plan)

.. workproduct:: Issue tracking system
:id: wp__issue_track_system
:status: valid
:tags: change_management
:complies: std_wp__iso26262__management_554, std_wp__iso26262__management_652, std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_wp__iso26262__support_854, std_wp__isopas8926__4527, std_req__aspice_40__iic-13-16, std_req__aspice_40__iic-13-07, std_req__aspice_40__iic-15-55, std_req__aspice_40__iic-15-12,
std_wp__isosae21434__continual_8333, std_wp__isosae21434__continual_8431, std_wp__isosae21434__continual_8531, std_wp__isosae21434__continual_8631
:tags: doc_lifecycle_model_1
:complies: std_wp__iso26262__management_554, std_wp__iso26262__management_652, std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_wp__iso26262__support_854, std_wp__isopas8926__4527, std_req__aspice_40__iic-13-16, std_req__aspice_40__iic-13-07, std_req__aspice_40__iic-15-55, std_req__aspice_40__iic-15-12

| - Change request
| - Change request plan
Expand All @@ -44,7 +43,7 @@ Change Management Work Products
.. workproduct:: Feature Request
:id: wp__feat_request
:status: valid
:tags: change_management
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_req__aspice_40__iic-13-16

| - Feature request for a new feature or a feature modification
Expand All @@ -55,14 +54,11 @@ Change Management Work Products
.. workproduct:: Component Request
:id: wp__cmpt_request
:status: valid
:tags: change_management
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_req__aspice_40__iic-13-16

| - Component request for a new component or a component modification
|
| Change Request for a new component or a modification of an existing component,
| which changes the scope of the component.
| Software Modules are also components (top-level component).

.. needextend:: docname is not None and "process_areas/change_management" in docname
:+tags: change_management
3 changes: 3 additions & 0 deletions process/process_areas/change_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ Change Management
change_management_roles
change_management_workflow
change_management_workproducts

.. needextend:: docname is not None and "process_areas/change_management" in docname
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Configuration Management Work Products
.. workproduct:: Platform Configuration Management Plan
:id: wp__config_mgt_plan
:status: valid
:tags: config_management
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__support_751

Config Management Plan (Part of the Platform Management Plan, :need:`wp__platform_mgmt`)
3 changes: 3 additions & 0 deletions process/process_areas/configuration_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ Configuration Management
configuration_roles
configuration_workflow
configuration_workproducts

.. needextend:: docname is not None and "process_areas/configuration_management" in docname
:+tags: configuration_management
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Documentation Management Work Products
.. workproduct:: Documentation Management Plan
:id: wp__document_mgt_plan
:status: valid
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__support_1051, std_wp__iso26262__support_1052, std_req__aspice_40__iic-01-52

Document Management Plan (Part of the Platform Management Plan)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,77 @@ For manual review of the formal elements the

The review of each document is done as defined for this type of work product in the respective
process description.


Document lifecycle models
-------------------------

Each released document shall have the status: “VALID”.

Depending on the document assigned lifecycle Model, as defined here
:ref:`work_products_overview_list`, the document can either reach this state directly,
or some prior states are required.

Thus different document lifecycle models exists (as defined in
:need:`gd_req__doc_attr_status`):

* Model1: "VALID"
* Model2: "DRAFT" -> "VALID"
* Model3: "DRAFT" -> "VALID" -> "VALID(INSPECTED)"


**Guidance for lifecycle model 1:**

Example: :need:`wp__issue_track_system`

The document has the state “VALID” after creation.

Recommendation: Author should do a self verification for the correctness and completeness
of the content and th fulfillment of required formal aspects.


**Guidance for lifecycle model 2:**

Example: :need:`wp__feat_request`

The document has the state “VALID” after creation and a reviewer as confirmed
the correctness and completeness of the content and th fulfillment of required formal
aspects.

The figure below shows an overview of the review workflow for lifecycle model 2 (Simple
Workflow) based on Pull Requests.

Nevertheless, it is still recommended for author to do a self verification for the
correctness and completeness of the content and the fulfillment of required formal
aspects before asking for a review.

In case of any discussions are needed between author and reviewer, or still some ambiguities
exists, the document can also be published first with the status "DRAFT".

This indicates, that the document is created, may have no mature structure yet, content
is not complete and correct or formal aspects are not considered.

The figure below shows an overview of the review workflow for lifecycle model 2
(Extended Workflow) based on Pull Requests.

After some iterations between author and reviewer, the document can be set to status
"VALID", when all issues are resolved.

Due to updates, findings, other issues or change request, the document status may set
back from "VALID" to "DRAFT". This triggers a new review cycle.


.. figure:: _assets/review_workflow.drawio.svg
:width: 100%
:align: center
:alt: Overview review lifecycle model 2

Overview review lifecycle model 2 for PRs


**Guidance for lifecycle model 3:**

In principle same as lifecycle model 2, but an additional inspection step is required,
as described here: :ref:`review_concept`.

Example: :need:`wp__requirements_stkh`
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,21 @@ Document Management Process Requirements

Compare also :need:`gd_temp__documentation`

.. gd_req:: Document attribute: status
:id: gd_req__doc_attr_status
:status: valid
:tags: manual_prio_1, attribute, mandatory
:satisfies: wf__platform_cr_mt_platform_mgmt_plan
:complies: std_req__iso26262__support_1044

Each document, shall have a status depending on the document lifecycle models below:

* Model 1: VALID (e.g. for simple reports)
* Model 2: DRAFT -> VALID (e.g. for plans)
* Model 3: DRAFT-> VALID -> VALID(inspected) (e.g. for stakeholder requirements)

Compare :need:`gd_guidl__documentation`

.. gd_req:: Document Author
:id: gd_req__doc_reviewer
:status: valid
Expand Down
2 changes: 1 addition & 1 deletion process/process_areas/documentation_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Documentation Management
documentation_workproducts

.. needextend:: docname is not None and "process_areas/documentation_management" in docname
:+tags: doc_mgt
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Implementation Work Products
.. workproduct:: Implementation
:id: wp__sw_implementation
:status: valid
:tags: safety
:tags: doc_lifecycle_model_3
:complies: std_wp__iso26262__software_851, std_wp__iso26262__software_852, std_wp__iso26262__software_app_c_53, std_req__aspice_40__iic-04-05, std_req__aspice_40__iic-11-05,

Implementation includes source code and detailed design (e.g. in form of comments or linked graphical representations) and SW configuration (e.g. #ifdef)
Expand All @@ -27,23 +27,20 @@ Implementation Work Products
.. workproduct:: Implementation Inspection
:id: wp__sw_implementation_inspection
:status: valid
:tags: safety
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__software_952

Github review with integrated inspection checklist, only valid Detailed Design and Code get merged

.. workproduct:: Software Development Plan
:id: wp__sw_development_plan
:status: valid
:tags: safety
:complies: std_wp__iso26262__software_551, std_wp__iso26262__software_app_c_58, std_wp__isosae21434__development_1053
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__software_551, std_wp__iso26262__software_app_c_58

Process description of SW development including
- selection of design and programming language
- design guideline
- coding guideline (e.g. MISRA, can also include style guide or naming convention)
- SW configuration guideline
- development tools

.. needextend:: docname is not None and "process_areas/implementation" in docname
:+tags: implementation
3 changes: 3 additions & 0 deletions process/process_areas/implementation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ Implementation
implementation_workflow
implementation_workproducts
_assets/detailed_design_example.rst

.. needextend:: docname is not None and "process_areas/implementation" in docname
:+tags: implementation
3 changes: 3 additions & 0 deletions process/process_areas/platform_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ Platform Management
platform_management_roles
platform_management_workflow
platform_management_workproducts

.. needextend:: docname is not None and "process_areas/platform_management" in docname
:+tags: platform_management
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Platform Management Work Products
.. workproduct:: Platform Management Plan
:id: wp__platform_mgmt
:status: valid
:tags: doc_lifecycle_model_2
:complies:

The Platform Management Plan shall include the plans as defined by the
Expand All @@ -33,6 +34,7 @@ Platform Management Work Products
.. workproduct:: Project Management Plan
:id: wp__project_mgt
:status: valid
:tags: doc_lifecycle_model_2
:complies: std_req__aspice_40__iic-08-53, std_req__aspice_40__iic-14-10, std_req__aspice_40__iic-13-52, std_req__aspice_40__iic-18-52, std_req__aspice_40__iic-08-56, std_req__aspice_40__iic-14-50

Project Management Plan (Part of the Platform Management Plan)
Expand All @@ -46,6 +48,3 @@ Platform Management Work Products
Defines the schedule of the project.

Defines escalation path.

.. needextend:: docname is not None and "process_areas/platform_management" in docname
:+tags: platform_management
3 changes: 3 additions & 0 deletions process/process_areas/problem_resolution/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ Problem Resolution
problem_resolution_roles
problem_resolution_workflow
problem_resolution_workproducts

.. needextend:: docname is not None and "process_areas/problem_resolution" in docname
:+tags: problem_resolution
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@ Problem Resolution Work Products
.. workproduct:: Platform Problem Resolution Plan
:id: wp__prm_plan
:status: valid
:tags: problem_resolution
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__support_851

Problem Resolution Plan (Part of the Platform Management Plan)

.. needextend:: docname is not None and "process_areas/problem_resolution" in docname
:+tags: problem_resolution
3 changes: 3 additions & 0 deletions process/process_areas/process_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ Process Management
process_management_roles
process_management_workflow
process_management_workproducts

.. needextend:: docname is not None and "process_areas/process_management" in docname
:+tags: process_management
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,12 @@ For a detailed explanation of workflows and their role within the process model,
:approved_by: rl__process_community
:supported_by: rl__external_auditor, rl__project_lead
:input: wp__policies, wp__issue_track_system
:output: wp__process_strategy
:output: wp__process_strategy, wp__policies
:contains: gd_guidl__process_management, gd_temp__process_workflow
:has: doc_concept__process_management, doc_getstrt__process_management

The process management strategy is created and maintained.
The process management strategy is created and maintained. Policies are
reviewed and updated, if required.

.. workflow:: Define/Approve Process Description
:id: wf__def_app_process_description
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,39 @@
Process Management Work Products
################################

Here only project specific work products are listed, which are generic for the platform.

.. workproduct:: Policies
:id: wp__policies
:status: draft
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__management_551

In general the project follows the Eclipse Foundation Development Process (EDP,
`Eclipse Foundation Development Process <https://www.eclipse.org/projects/dev_process/>`_).
The EDP defines important concepts, including the Open Source Rules of Engagement,
the organizational framework for open source projects and teams, releases, reviews,
and more.

Further the Eclipse Foundation Security Policy
(`Eclipse Foundation Security Policy <https://www.eclipse.org/security/policy/>`_)
applies.

The Eclipse Foundation Functional Safety Process (EFFSP, currently in DRAFT
`Eclipse Foundation Functional Safety Process <https://gitlab.eclipse.org/eclipsefdn/emo-team/policies/functional-safety-process/-/blob/main/source/fsp.adoc?ref_type=heads>`_)
applies.

Concerning the use of Generative Artificial Intelligence
`Usage Guidelines <https://www.eclipse.org/projects/guidelines/genai/>`_ applies.

Project specific Policies for functional safety and cybersecurity may extend the
ones from ECLIPSE.


.. workproduct:: Process Management Strategy
:id: wp__process_strategy
:status: valid
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__management_551, std_wp__isosae21434__org_management_551, std_wp__isosae21434__org_management_552, std_wp__isosae21434__org_management_553, std_wp__isosae21434__org_management_554, std_wp__isosae21434__org_management_555

Strategy to manage and guide execution of the process management activities.
Expand All @@ -32,6 +62,7 @@ Process Management Work Products
.. workproduct:: Process Description
:id: wp__process_description
:status: valid
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__management_551, std_wp__isosae21434__org_management_551, std_wp__isosae21434__org_management_552, std_wp__isosae21434__org_management_553, std_wp__isosae21434__org_management_554, std_wp__isosae21434__org_management_555, std_req__aspice_40__iic-10-00, std_req__aspice_40__iic-10-50, std_req__aspice_40__iic-06-51, std_req__aspice_40__iic-15-54, std_req__aspice_40__iic-14-53

The process description is defined here: :ref:`process_description`.
Expand All @@ -41,14 +72,11 @@ Process Management Work Products
.. workproduct:: Tailoring Document Work Products
:id: wp__tailoring_work_products
:status: valid
:complies: std_wp__iso26262__management_651, std_wp__iso26262__management_751, std_wp__iso26262__system_652, std_wp__iso26262__system_653, std_wp__iso26262__system_654, std_wp__iso26262__system_655, std_wp__iso26262__system_656, std_wp__iso26262__system_657, std_wp__iso26262__system_751, std_wp__iso26262__system_752, std_wp__iso26262__system_851, std_wp__iso26262__system_852, std_wp__iso26262__software_652, std_wp__iso26262__software_1151, std_wp__iso26262__software_1152, std_wp__iso26262__software_app_c_52, std_wp__iso26262__software_app_c_54, std_wp__iso26262__software_app_c_57, std_wp__iso26262__support_551, std_wp__iso26262__support_552, std_wp__iso26262__support_553, std_wp__iso26262__support_554, std_wp__iso26262__support_555, std_wp__iso26262__support_1351, std_wp__iso26262__support_1352, std_wp__iso26262__support_1353, std_wp__iso26262__support_1451, std_wp__iso26262__support_1452, std_wp__iso26262__support_1551, std_wp__iso26262__support_1651, std_wp__iso26262__analysis_551, std_wp__iso26262__analysis_552, std_wp__isopas8926__4522,
std_wp__isosae21434__assessment_15331, std_wp__isosae21434__assessment_15531
:tags: doc_lifecycle_model_2
:complies: std_wp__iso26262__management_651, std_wp__iso26262__management_751, std_wp__iso26262__system_652, std_wp__iso26262__system_653, std_wp__iso26262__system_654, std_wp__iso26262__system_655, std_wp__iso26262__system_656, std_wp__iso26262__system_657, std_wp__iso26262__system_751, std_wp__iso26262__system_752, std_wp__iso26262__system_851, std_wp__iso26262__system_852, std_wp__iso26262__software_652, std_wp__iso26262__software_1052, std_wp__iso26262__software_1151, std_wp__iso26262__software_1152, std_wp__iso26262__software_app_c_52, std_wp__iso26262__software_app_c_54, std_wp__iso26262__software_app_c_57, std_wp__iso26262__support_551, std_wp__iso26262__support_552, std_wp__iso26262__support_553, std_wp__iso26262__support_554, std_wp__iso26262__support_555, std_wp__iso26262__support_1351, std_wp__iso26262__support_1352, std_wp__iso26262__support_1353, std_wp__iso26262__support_1451, std_wp__iso26262__support_1452, std_wp__iso26262__support_1551, std_wp__iso26262__support_1651, std_wp__iso26262__analysis_551, std_wp__iso26262__analysis_552, std_wp__isopas8926__4522

This work product "definition" links to all the work products which are not covered by the
processes work products documented. Make sure these are tailored out in the safety, security and quality plans
for your project (documented in the PMP), to be able to demonstrate completeness.
It is not really a work product definition,
but this is the best way to link to the tailored out standard work products.

.. needextend:: docname is not None and "process_areas/process_management" in docname
:+tags: process_management
Loading
Loading