diff --git a/docs/features/feature_example/architecture/chklst_arc_inspection.rst b/docs/features/feature_example/architecture/chklst_arc_inspection.rst index 5ac5c459..88d85133 100644 --- a/docs/features/feature_example/architecture/chklst_arc_inspection.rst +++ b/docs/features/feature_example/architecture/chklst_arc_inspection.rst @@ -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. diff --git a/docs/features/feature_example/architecture/index.rst b/docs/features/feature_example/architecture/index.rst index bff99e46..88564907 100644 --- a/docs/features/feature_example/architecture/index.rst +++ b/docs/features/feature_example/architecture/index.rst @@ -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 -------- diff --git a/docs/features/feature_example/index.rst b/docs/features/feature_example/index.rst index 36924947..17248bf2 100644 --- a/docs/features/feature_example/index.rst +++ b/docs/features/feature_example/index.rst @@ -29,7 +29,6 @@ For the main feature description and requirements, see the belonging `Feature - - - -Security Work products List -=========================== - -.. list-table:: Feature Work products - :header-rows: 1 - - * - Work product Id - - Link to process - - Process status - - Link to WP - - * - :need:`wp__feat_request` - - :need:`gd_temp__change_feature_request` - - :ndf:`copy('status', need_id='gd_temp__change_feature_request')` - - :need:`doc__feature_name` - - * - :need:`wp__requirements_feat` - - :need:`gd_temp__req_feat_req` - - :ndf:`copy('status', need_id='gd_temp__req_feat_req')` - - :need:`doc__feature_name_requirements` - - * - :need:`wp__requirements_feat_aou` - - :need:`gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - - :need:`doc__feature_name_requirements` - - * - :need:`wp__feature_arch` - - :need:`gd_temp__arch_feature` - - :ndf:`copy('status', need_id='gd_temp__arch_feature')` - - :need:`doc__feature_name_architecture` - - * - :need:`wp__requirements_inspect` - - :need:`gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - - :need:`doc__feature_name_req_inspection` - - * - :need:`wp__sw_arch_verification` - - :need:`gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - - :need:`doc__feature_name_arc_inspection` - - * - :need:`wp__verification_feat_int_test` - - :need:`gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - - - -.. attention:: - The above table must be updated according to your feature security planning. - - - Fill the work producs links - -Feature Security Package -======================== - -To create the security package (according to :need:`gd_guidl__security_package`) the following -documents and work products status have to go to "valid" (after the relevant verification were performed). - -Feature Documents Status ------------------------- - -For all the work product documents the status can be seen by following the "Link to WP". -A summary of the status is also documented in the project's documentation management plan. - -See - -Feature Requirements Status ---------------------------- - -.. needtable:: - :filter: docname is not None and "feature_name" in docname and "requirements" in docname - :style: table - :types: feat_req - :tags: feature_name - :columns: id;status - :colwidths: 25,25 - :sort: title - -Feature AoU Status ------------------- - -.. needtable:: - :filter: docname is not None and "feature_name" in docname and "requirements" in docname - :style: table - :types: aou_req - :tags: feature_name - :columns: id;status - :colwidths: 25,25 - :sort: title - -Feature Architecture Status ---------------------------- - -.. needtable:: - :filter: docname is not None and "feature_name" in docname and "architecture" in docname - :style: table - :types: feat_arc_sta; feat_arc_dyn - :tags: feature_name - :columns: id;status - :colwidths: 25,25 - :sort: title diff --git a/docs/safety_mgt/module_safety_plan.rst b/docs/safety_mgt/module_safety_plan.rst index 06d4a820..020e496b 100644 --- a/docs/safety_mgt/module_safety_plan.rst +++ b/docs/safety_mgt/module_safety_plan.rst @@ -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')` - - + - :need:`doc__mod_temp_module_name_safety_analysis_fdr` * - :need:`wp__audit_report` - performed by external experts diff --git a/docs/security_mgt/module_security_plan.rst b/docs/security_mgt/module_security_plan.rst index f4e34ddf..6bece6b4 100644 --- a/docs/security_mgt/module_security_plan.rst +++ b/docs/security_mgt/module_security_plan.rst @@ -110,13 +110,6 @@ Security Plan - - - * - :need:`wp__module_sw_release_note` - - :need:`Software Development Plan Template ` - - - - - - - - - * - :need:`wp__module_security_manual` - :need:`gd_temp__module_security_manual` - diff --git a/score/component_example/docs/architecture/chklst_arc_inspection.rst b/score/component_example/docs/architecture/chklst_arc_inspection.rst index ee3fbb73..58919170 100644 --- a/score/component_example/docs/architecture/chklst_arc_inspection.rst +++ b/score/component_example/docs/architecture/chklst_arc_inspection.rst @@ -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 `) is implemented. Refer to `Tool Requirements `_ 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? diff --git a/score/component_example/docs/index.rst b/score/component_example/docs/index.rst index 2902f98b..86ebabcb 100644 --- a/score/component_example/docs/index.rst +++ b/score/component_example/docs/index.rst @@ -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 diff --git a/score/component_example/docs/safety_analysis/aou_requirements_template.rst b/score/component_example/docs/safety_analysis/aou_requirements.rst similarity index 70% rename from score/component_example/docs/safety_analysis/aou_requirements_template.rst rename to score/component_example/docs/safety_analysis/aou_requirements.rst index 67c0f340..098b7029 100644 --- a/score/component_example/docs/safety_analysis/aou_requirements_template.rst +++ b/score/component_example/docs/safety_analysis/aou_requirements.rst @@ -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.