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 @@ -75,10 +75,10 @@ See also :need:`doc_concept__wp_inspections` for further information about revie
-
* - ARC_01_02
- Does the software architecture design consider all the requirements allocated to the architectural element, including functional, non-functional, safety, and security requirements and all related design decisions?
- manual
- Check if all requirements allocated to the architectural element are considered in the design. This includes functional requirements (e.g. functional safety requirements), non-functional requirements (e.g. performance, reliability), and security requirements (e.g. confidentiality, integrity). Additionally, ensure that all related design decisions are taken into account and documented in the architectural design.
-
-
-
* - ARC_01_03
- If the architectural element is related to any supplier manuals (including safety and security), are the relevant parts covered?
- If the architecture makes use of supplied elements, their manuals (like safety) have to be considered (i.e. its provided functionality matches the expectation and assumptions are fulfilled). Note that in case of safety component this means that assumed Technical Safety Requirements and AoUs of the safety manual are covered.
Expand Down
2 changes: 1 addition & 1 deletion docs/features/feature_example/architecture/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Feature Architecture
- Modify ``Your Feature Name`` to be your Feature Name
- Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and followed by ``_architecture``
- Adjust ``status`` to be ``valid``
- Adjust ``safety`` and ``tags`` according to your needs
- Adjust ``safety``, ``security`` and ``tags`` according to your needs

Overview
--------
Expand Down
3 changes: 1 addition & 2 deletions docs/features/feature_example/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ For the main feature description and requirements, see the belonging `Feature <h
architecture/chklst_arc_inspection.rst
safety_analysis/fmea.rst
safety_analysis/dfa.rst
safety_analysis/aou_requirements_template.rst
safety_analysis/aou_requirements.rst
safety_planning/index.rst
security_planning/index.rst
security_analysis/index.rst

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of removing, should we not keep it as empty placeholder for the future?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left the folder to align with what is done in component level

Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,26 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

AoU Feature Requirements Template
=================================
AoU Feature Requirements
========================

.. document:: [Your Feature Name] Feature AoU
:id: doc__feature_name_feat_aou
:status: draft
:safety: ASIL_B
:security: NO
:realizes: wp__requirements_feat_aou
:tags: template


.. attention::
The above directive must be updated according to your Feature.

- Modify ``Your Feature Name`` to be your Feature Name
- Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and followed by ``_feat_aou``
- Adjust ``status`` to be ``valid``
- Adjust ``safety``, ``security`` and ``tags`` according to your needs


This page contains Assumption of Use requirement snippets that belong to the
template repository.
Expand Down
Empty file.
145 changes: 0 additions & 145 deletions docs/features/feature_example/security_analysis/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/safety_mgt/module_safety_plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Module Work products List
* - :need:`wp__fdr_reports` (module's Safety Analyses & DFA)
- :need:`gd_chklst__safety_analysis`
- :ndf:`copy('status', need_id='gd_chklst__safety_analysis')`
- <Link to WP>
- :need:`doc__mod_temp_module_name_safety_analysis_fdr`

* - :need:`wp__audit_report`
- performed by external experts
Expand Down
7 changes: 0 additions & 7 deletions docs/security_mgt/module_security_plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,6 @@ Security Plan
- <Link to WP>
- <WP status (manual)>

* - :need:`wp__module_sw_release_note`
- :need:`Software Development Plan Template <gd_temp__software_development_plan>`
- <automated>
- <Link to issue>
- <Link to WP>
- <automated>

* - :need:`wp__module_security_manual`
- :need:`gd_temp__module_security_manual`
- <automated>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,16 @@ See also :need:`doc_concept__wp_inspections` for further information about revie
- Issue link
* - ARC_01_01
- Is the traceability from software architectural elements to requirements, and other level architectural elements (e.g. component to interface) established according to the "Relations between the architectural elements" as described in :need:`doc_concept__arch_process`?
- automated
- Trace should be checked automatically by tool support in the future. Will be removed from the checklist once the requirement (:need:`Correlations of the architectural building blocks <gd_req__arch_build_blocks_corr>`) is implemented. Refer to `Tool Requirements <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html>`_ for the current status.
-
-
-
* - ARC_01_02
- Does the software architecture design consider all the requirements allocated or belonging to the architectural element, including functional, non-functional, safety, and security requirements and all related design decisions?
- manual
- Check if all requirements allocated or belonging to the architectural element are considered in the design. This includes functional requirements (e.g. functional safety requirements), non-functional requirements (e.g. performance, reliability), and security requirements (e.g. confidentiality, integrity). Additionally, ensure that all related design decisions are taken into account and documented in the architectural design.
-
-
-
* - ARC_01_03
- If the architectural element is related to any supplier manuals (incl. safety and security)
are the relevant parts covered?
Expand Down
2 changes: 1 addition & 1 deletion score/component_example/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,5 +174,5 @@ Component Detail Information
requirements/index
safety_analysis/dfa
safety_analysis/fmea
safety_analysis/aou_requirements_template
safety_analysis/aou_requirements
component_classification
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,23 @@
AoU Component Requirements Template
===================================

.. document:: [Your Component Name] Component AoU
:id: doc__component_name_feat_aou
:status: draft
:safety: ASIL_B
:security: NO
:realizes: wp__requirements_comp_aou
:tags: template


.. attention::
The above directive must be updated according to your Component.

- Modify ``Your Component Name`` to be your Component Name
- Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_comp_aou``
- Adjust ``status`` to be ``valid``
- Adjust ``safety``, ``security`` and ``tags`` according to your needs

This page contains Assumption of Use requirement snippets that belong to the
template repository.

Expand Down
Loading