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 @@ -77,5 +77,5 @@ Feature Requirements
- Adjust ``valid_from`` and ``valid_until`` to the right version numbers
- Set ``status`` to ``valid`` and start the review/merge process

.. needextend:: docname is not None and "feature_name" in id
.. needextend:: c.this_doc() and docname is not None and "feature_name" in id
:+tags: feature_name
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,5 @@ Stakeholder Requirements
- Add other needed requirements for the platform
- Set ``status`` to ``valid`` and start the review/merge process

.. needextend:: "platform" in id
.. needextend:: c.this_doc() and "platform" in id
:+tags: platform
Original file line number Diff line number Diff line change
Expand Up @@ -573,3 +573,6 @@ Limitations
* Grouping functionality needs improvement
* Manual extendability is limited to the same type as the underlying drawing, either class or association diagram types
* Currently only uses the need attributes *includes, included_by, uses, implements*

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ General Workflow
Architecture Design Workflow

The above figure shows all steps which are required to create an architectural design. In this getting started only a short overview is given. A more detailed description of all the step is provided in the :need:`guideline <gd_guidl__arch_design>`.

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ Contributing Roles:
A detailed overview of the responsibility for the steps of the architecture design process is listed here:

:ref:`arch_workflow`

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,6 @@ RAS(IC) for Architecture Design:
:sort: status
:columns: id as "Activity";responsible as "Responsible";approved_by as "Approver";supported_by as "Supporter"
:colwidths: 30,30,30,30

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,6 @@ Architecture Work Products

Depends on architecture guideline and tooling.
May include several methods like inspection, modelling, ... which are selected in projects SW Verification Plan.

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -359,3 +359,6 @@ Since SCORE provides a middleware platform, the following aspects are explicitly
* System-level safety architecture (e.g., ASIL decomposition at vehicle level)

Architectural views describing integration aspects at the system level (above platform boundary) are the responsibility of the platform user (system integrator). The platform shall provide Assumptions of Use (AoU) documenting architectural constraints that the platform user must satisfy. These responsibilities shall be communicated to platform users via AoUs associated with the platform and feature architectures.

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Architecture Inspection Checklist Template
std_req__aspice_40__SWE-2-BP4[version==1],
std_req__aspice_40__iic-13-51[version==1],
std_req__aspice_40__SWE-2-BP5[version==1],
std_req__aspice_40__iic-08-63[version==1],
std_req__aspice_40__iic-08-63[version==1],
std_req__aspice_40__iic-03-06[version==1]

For the content see here:
Expand All @@ -39,3 +39,6 @@ Architecture Inspection Checklist Template
- `Feature Architecture Inspection Checklist <https://eclipse-score.github.io/module_template/main/features/feature_example/architecture/chklst_arc_inspection.html>`__

These two documents have the same questions, but different scope and document naming.

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -360,3 +360,6 @@ Process Monitoring and Improvement
Monitoring is expected as a periodic, predominantly manual activity (for example as part of quality checks and retrospectives), not as a fully automated check.

Improvement actions should be handled according to :ref:`pm_monitor_improve_process`.

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ Component Architecture Template

For the content see the
`module template documentation <https://eclipse-score.github.io/module_template/main/components/component_example/architecture/component_architecture.html>`__.

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ Feature Architecture Template
std_req__aspice_40__iic-04-04[version==1]

For the content see here: :ref:`feature_architecture_template`

.. needextend:: "c.this_doc()"
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ Guidances
feature_architecture_template
component_architecture_template
architecture_process_reqs

.. needextend:: "c.this_doc()"
:+tags: architecture_design
4 changes: 0 additions & 4 deletions process/process_areas/architecture_design/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,3 @@ Architecture Design
architecture_roles
architecture_workflow
architecture_workproducts


.. needextend:: docname is not None and "process_areas/architecture_design" in docname
:+tags: architecture_design
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,6 @@ The standards require that a Change Request can be traced throughout the complet
hierarchy levels including all affected work products.

In general the traceability is visualized in the general traceability concept (:ref:`general_concepts_traceability`).

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,6 @@ For every change identified, the following workflows are executed:
* Close the change request according to :need:`wf__change_close_cr`

In addition create a change management plan as part of the platform management plan according to :need:`wf__platform_cr_mt_platform_mgmt_plan`

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ Contributing Roles:
A detailed overview of the responsibility for the steps of the requirement process is listed here:

:ref:`workflow_chm_requirements`

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,6 @@ Change Management Work Products
| Change Request for a new component or a modification of an existing component,
| which changes the scope of the component.
| This includes the allocation of components into SW Modules.

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,6 @@ Checklists
* - 11
- Does the Change Request has verification measure as specified?
-

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,6 @@ Component Template
std_req__aspice_40__iic-14-02[version==1]

for the content see `Component Request Template <https://eclipse-score.github.io/module_template/main/components/component_example/index.html>`__

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ Decision Record Template
:complies: std_req__aspice_40__SWE-2-BP3[version==1], std_req__aspice_40__iic-17-00[version==1]

For the content see here: :ref:`decision_record_template`.

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@ Feature Template
std_req__aspice_40__iic-14-02[version==1]

for the content see :need:`doc__feature_name`

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -305,3 +305,6 @@ Tailoring
The reasoning is:

- Trustable Software Framework is planned for evaluation of existing OSS, thus the requirements for evaluation are not applicable.

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,6 @@ License Impact
==============

[How could the copyright impacted by the license of the new contribution?]

.. needextend:: "c.this_doc()"
:+tags: change_management
3 changes: 3 additions & 0 deletions process/process_areas/change_management/guidance/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ Guidance
change_management_impact_analysis_template
change_management_reqs
change_management_decision_record_template

.. needextend:: "c.this_doc()"
:+tags: change_management
3 changes: 0 additions & 3 deletions process/process_areas/change_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,3 @@ Change Management
change_management_roles
change_management_workflow
change_management_workproducts

.. needextend:: "c.this_doc()"
:+tags: change_management
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,6 @@ Almost all requirements of the standards towards configuration management can be
standard versioning tooling and of tooling for the "Docs-as-Code" approach.

For the automated storage additional tooling is needed see :doc:`guidance/configuration_process_req`)

.. needextend:: "c.this_doc()"
:+tags: configuration_management
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@ In case you are appointed as a :need:`rl__project_lead` in the project:

As a normal contributor or committer consult the configuration management plan, it should
be mainly your task to use the project's selected version management tool.

.. needextend:: "c.this_doc()"
:+tags: configuration_management
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ Contributing Roles:
A detailed overview of the responsibility for the steps of the configuration management is listed here:

:need:`wf__platform_cr_mt_platform_mgmt_plan`

.. needextend:: "c.this_doc()"
:+tags: configuration_management
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ Thus the work flow :need:`wf__platform_cr_mt_platform_mgmt_plan` applies.
Baselines (sets of configuration items and their versions) defining a SW Release on platform or module level
are created as part of this process but are documented in the respective release notes.
This is part of workflows :need:`wf__rel_mod_rel_note` and :need:`wf__rel_platform_rel_note`

.. needextend:: "c.this_doc()"
:+tags: configuration_management
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ Configuration Management Work Products
:complies: std_wp__iso26262__support_751[version==1]

Config Management Plan (Part of the Platform Management Plan, :need:`wp__platform_mgmt`)

.. needextend:: "c.this_doc()"
:+tags: configuration_management
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,6 @@ Configuration Management Process Requirements
It shall be possible to define global tags with the docs-as-code tool, which can be used for filtering and reporting.

Note: This requirement exists to enable the use of global tags for filtering and reporting purposes, while still prohibiting the overriding of mandatory attributes or elements globally.

.. needextend:: "c.this_doc()"
:+tags: configuration_management
Original file line number Diff line number Diff line change
Expand Up @@ -182,3 +182,6 @@ The respective tools used in the project are:
Note 1: A versioning tool covers part of configuration management but not all (namely: storage, retrieval, control and modification, branching and baselining).

Note 2: A "Docs-as-Code" tool is used to identify, attribute and link parts of text files and generate human and machine readable documentation.

.. needextend:: "c.this_doc()"
:+tags: configuration_management
3 changes: 0 additions & 3 deletions process/process_areas/configuration_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,3 @@ 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 @@ -86,3 +86,6 @@ Guidance
^^^^^^^^

The document management guideline can be found here :need:`gd_guidl__documentation`.

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ General Workflow
****************

The main workflow is to create and maintain the :need:`wp__document_mgt_plan`.

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ Contributing Roles:
A detailed overview of the responsibility for the steps of the documentation management is listed here:

:need:`wf__platform_cr_mt_platform_mgmt_plan`

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ management plan. Thus the work flow :need:`wf__platform_cr_mt_platform_mgmt_plan

The documentation management plan should contain the strategy to manage the identified
documentations in an effective and repeatable way for the project life cycle.

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,6 @@ Documentation Management Work Products
* How to avoid distribution of obsolete documents?
* Which formal elements are used?
* List of all documents including their status

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,6 @@ Checklists
* - 6
- Is the Document linked via realizes to the correct workproduct of the process description?
-

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,6 @@ In principle same as lifecycle model 2, but an additional inspection step is req
as described here: :ref:`review_concept`.

Example: :need:`wp__requirements_stkh`

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -121,3 +121,6 @@ Document Management Process Requirements
which is usually the person with "write-rights" on the document approving
the merge of a Pull Request (this may also be more than one person).
Note that every approver is also reviewer.

.. needextend:: "c.this_doc()"
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@ Documentation Templates
| :security: <YES|NO>
| :safety: <QM|ASIL_B>
| :realizes: wp__<name of wp in process description>

.. needextend:: "c.this_doc()"
:+tags: documentation_management
3 changes: 0 additions & 3 deletions process/process_areas/documentation_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,3 @@ Documentation Management
documentation_roles
documentation_workflow
documentation_workproducts

.. needextend:: docname is not None and "process_areas/documentation_management" in docname
:+tags: documentation_management
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ Detailed Design Template
std_req__aspice_40__iic-04-05[version==1]

For the content see here: `Detailed Design Template <https://eclipse-score.github.io/module_template/main/components/component_example/detailed_design/index.html>`__

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@ Implementation Inspection Checklist
For the content see here:

- `Component Implementation Inspection Checklist <https://eclipse-score.github.io/module_template/main/components/component_example/detailed_design/chklst_impl_inspection.html>`__

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -274,3 +274,6 @@ Example using PlantUML:
UnitA -> UnitB : request()
UnitB --> UnitA : response()
@enduml

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,6 @@ SW development tools
^^^^^^^^^^^^^^^^^^^^

Description of used SW development tools.

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,6 @@ continuous improvements in quality through multiple cycles of refinement.
The implementation concept intentionally stays at a high level. Practical guidance for
unit decomposition, source-code documentation, optional diagrams and naming consistency
for traceability is defined in :need:`Implementation Guideline <gd_guidl__implementation>`.

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,6 @@ Developer Experience

There are some tests intended to check e.g. format which are described in
https://github.com/eclipse-score/score/blob/main/README.md.

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ Contributing Roles:
A detailed overview of the responsibility for the steps of the requirement process is listed here:

:ref:`workflow_implementation`

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,6 @@ RAS(IC) for Implementation:
:sort: status
:columns: id as "Activity";responsible as "Responsible";approved_by as "Approver";supported_by as "Supporter"
:colwidths: 30,30,30,30

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,6 @@ Implementation Work Products
- coding guideline (e.g. MISRA, can also include style guide or naming convention)
- SW configuration guideline
- development tools

.. needextend:: "c.this_doc()"
:+tags: implementation
3 changes: 0 additions & 3 deletions process/process_areas/implementation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,3 @@ Implementation
implementation_roles
implementation_workflow
implementation_workproducts

.. needextend:: "c.this_doc()"
:+tags: implementation
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,6 @@ Tailoring
The reasoning is:

- Main deliveries are source code, which is not a product, thus product risk management and process risk is not applicable (for safety and security related risk separate processes as safety/security analysis exists).

.. needextend:: "c.this_doc()"
:+tags: platform_management
Loading
Loading