diff --git a/docs/features/feature_example/architecture/chklst_arc_inspection.rst b/docs/features/feature_example/architecture/chklst_arc_inspection.rst index 88d85133..5cc9cc75 100644 --- a/docs/features/feature_example/architecture/chklst_arc_inspection.rst +++ b/docs/features/feature_example/architecture/chklst_arc_inspection.rst @@ -16,6 +16,7 @@ .. document:: [Your Feature Name] Architecture Inspection Checklist :id: doc__feature_name_arc_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__sw_arch_verification diff --git a/docs/features/feature_example/architecture/index.rst b/docs/features/feature_example/architecture/index.rst index 88564907..8b15a4f7 100644 --- a/docs/features/feature_example/architecture/index.rst +++ b/docs/features/feature_example/architecture/index.rst @@ -20,6 +20,7 @@ Feature Architecture .. document:: [Your Feature Name] Architecture :id: doc__feature_example_architecture :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__feature_arch diff --git a/docs/features/feature_example/safety_analysis/aou_requirements.rst b/docs/features/feature_example/safety_analysis/aou_requirements.rst index bd6dd99a..3c0bc0ca 100644 --- a/docs/features/feature_example/safety_analysis/aou_requirements.rst +++ b/docs/features/feature_example/safety_analysis/aou_requirements.rst @@ -18,6 +18,7 @@ AoU Feature Requirements .. document:: [Your Feature Name] Feature AoU :id: doc__feature_name_feat_aou :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__requirements_feat_aou diff --git a/docs/features/feature_example/safety_analysis/dfa.rst b/docs/features/feature_example/safety_analysis/dfa.rst index cfaf6974..39ffcbbf 100644 --- a/docs/features/feature_example/safety_analysis/dfa.rst +++ b/docs/features/feature_example/safety_analysis/dfa.rst @@ -19,6 +19,7 @@ DFA (Dependent Failure Analysis) .. document:: [Your Feature Name] DFA :id: doc__feature_name_dfa :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__feature_dfa diff --git a/docs/features/feature_example/safety_analysis/fmea.rst b/docs/features/feature_example/safety_analysis/fmea.rst index 255ad4e5..d60a214b 100644 --- a/docs/features/feature_example/safety_analysis/fmea.rst +++ b/docs/features/feature_example/safety_analysis/fmea.rst @@ -19,6 +19,7 @@ FMEA (Failure Modes and Effects Analysis) .. document:: [Your Feature Name] FMEA :id: doc__feature_name_fmea :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__feature_fmea diff --git a/docs/features/feature_example/safety_planning/index.rst b/docs/features/feature_example/safety_planning/index.rst index 8baf1117..38f14758 100644 --- a/docs/features/feature_example/safety_planning/index.rst +++ b/docs/features/feature_example/safety_planning/index.rst @@ -20,6 +20,7 @@ Feature Safety Work Products List .. document:: [Your Feature Name] Safety WPs :id: doc__feature_example_safety_wp :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__platform_safety_plan diff --git a/docs/features/feature_example/security_planning/index.rst b/docs/features/feature_example/security_planning/index.rst index 0271d6d1..cf1054e4 100644 --- a/docs/features/feature_example/security_planning/index.rst +++ b/docs/features/feature_example/security_planning/index.rst @@ -20,6 +20,7 @@ Feature Security Work Products List .. document:: [Your Feature Name] Security WPs :id: doc__feature_example_security_planning_wp :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__platform_security_plan diff --git a/docs/manuals/safety_manual.rst b/docs/manuals/safety_manual.rst index 0e112a4e..372b8d16 100644 --- a/docs/manuals/safety_manual.rst +++ b/docs/manuals/safety_manual.rst @@ -20,6 +20,7 @@ Safety Manual .. document:: [Your Module Name] Safety Manual :id: doc__mod_temp_module_name_safety_manual :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__module_safety_manual diff --git a/docs/manuals/security_manual.rst b/docs/manuals/security_manual.rst index 90971e43..b3b5e1b4 100644 --- a/docs/manuals/security_manual.rst +++ b/docs/manuals/security_manual.rst @@ -20,6 +20,7 @@ Security Manual .. document:: [Your Module Name] Security Manual :id: doc__mod_temp_module_name_security_manual :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__module_security_manual diff --git a/docs/release/release_note.rst b/docs/release/release_note.rst index 2b44f714..06ba2c35 100644 --- a/docs/release/release_note.rst +++ b/docs/release/release_note.rst @@ -20,6 +20,7 @@ Release Note .. document:: [Your Module Name] Release Note :id: doc__mod_temp_module_name_release_note :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__module_sw_release_note diff --git a/docs/safety_mgt/module_safety_analysis_fdr.rst b/docs/safety_mgt/module_safety_analysis_fdr.rst index ef4226c0..a0df35e2 100644 --- a/docs/safety_mgt/module_safety_analysis_fdr.rst +++ b/docs/safety_mgt/module_safety_analysis_fdr.rst @@ -19,6 +19,7 @@ Safety Analysis Checklist .. document:: [Your Module Name] Safety Analysis Checklist :id: doc__mod_temp_module_name_safety_analysis_fdr :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__fdr_reports diff --git a/docs/safety_mgt/module_safety_package_fdr.rst b/docs/safety_mgt/module_safety_package_fdr.rst index 1f37b8d2..2e5adcdf 100644 --- a/docs/safety_mgt/module_safety_package_fdr.rst +++ b/docs/safety_mgt/module_safety_package_fdr.rst @@ -20,6 +20,7 @@ Safety Package Formal Review Report .. document:: [Your Module Name] Safety Package Formal Review :id: doc__mod_temp_module_name_safety_package_fdr :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__fdr_reports diff --git a/docs/safety_mgt/module_safety_plan.rst b/docs/safety_mgt/module_safety_plan.rst index 020e496b..fd7bd48c 100644 --- a/docs/safety_mgt/module_safety_plan.rst +++ b/docs/safety_mgt/module_safety_plan.rst @@ -20,6 +20,7 @@ Safety Plan .. document:: [Your Module Name] Safety Plan :id: doc__mod_temp_module_name_safety_plan :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__module_safety_plan diff --git a/docs/safety_mgt/module_safety_plan_fdr.rst b/docs/safety_mgt/module_safety_plan_fdr.rst index c887bb40..3a594714 100644 --- a/docs/safety_mgt/module_safety_plan_fdr.rst +++ b/docs/safety_mgt/module_safety_plan_fdr.rst @@ -20,6 +20,7 @@ Safety Plan Formal Review Report .. document:: [Your Module Name] Safety Plan Formal Review :id: doc__mod_temp_module_name_safety_plan_fdr :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__fdr_reports diff --git a/docs/security_mgt/module_security_package_fdr.rst b/docs/security_mgt/module_security_package_fdr.rst index bccb43c5..be86b322 100644 --- a/docs/security_mgt/module_security_package_fdr.rst +++ b/docs/security_mgt/module_security_package_fdr.rst @@ -20,6 +20,7 @@ Security Package Formal Review Report .. document:: [Your Module Name] Security Package Formal Review :id: doc__mod_temp_module_name_sec_pkg_fdr :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__fdr_reports diff --git a/docs/security_mgt/module_security_plan.rst b/docs/security_mgt/module_security_plan.rst index 6bece6b4..628b1c3b 100644 --- a/docs/security_mgt/module_security_plan.rst +++ b/docs/security_mgt/module_security_plan.rst @@ -20,6 +20,7 @@ Security Plan .. document:: [Your Module Name] Security Plan :id: doc__mod_temp_module_name_security_plan :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__module_security_plan diff --git a/docs/security_mgt/module_security_plan_fdr.rst b/docs/security_mgt/module_security_plan_fdr.rst index f23cacc1..1be77a04 100644 --- a/docs/security_mgt/module_security_plan_fdr.rst +++ b/docs/security_mgt/module_security_plan_fdr.rst @@ -20,6 +20,7 @@ Security Plan Formal Review Report .. document:: [Your Module Name] Security Plan Formal Review :id: doc__mod_temp_module_name_security_plan_fdr :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__fdr_reports diff --git a/docs/verification_report/module_verification_report.rst b/docs/verification_report/module_verification_report.rst index d5f4c3a5..b0f96b52 100644 --- a/docs/verification_report/module_verification_report.rst +++ b/docs/verification_report/module_verification_report.rst @@ -20,6 +20,7 @@ Verification Report .. document:: [Your Module Name] Verification Report :id: doc__mod_temp_module_name_verification_report :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__verification_module_ver_report diff --git a/examples/docs/architecture_modeling_example.rst b/examples/docs/architecture_modeling_example.rst index 14c6900f..73be31ef 100644 --- a/examples/docs/architecture_modeling_example.rst +++ b/examples/docs/architecture_modeling_example.rst @@ -29,6 +29,7 @@ Feature Architecture File :security: YES :safety: QM :status: valid + :version: 1 :includes: logic_arc_int__example_feature__if_1, logic_arc_int__example_feature__if_2, logic_arc_int__example_feature__if_3 This is the example feature which shall normally defined in the platform repo. diff --git a/score/component_example/docs/architecture/chklst_arc_inspection.rst b/score/component_example/docs/architecture/chklst_arc_inspection.rst index 58919170..d6debef0 100644 --- a/score/component_example/docs/architecture/chklst_arc_inspection.rst +++ b/score/component_example/docs/architecture/chklst_arc_inspection.rst @@ -16,6 +16,7 @@ .. document:: [Your Component Name] Architecture Inspection Checklist :id: doc__mod_temp_component_name_arc_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__sw_arch_verification diff --git a/score/component_example/docs/architecture/component_architecture.rst b/score/component_example/docs/architecture/component_architecture.rst index b3063346..a6a58eb3 100644 --- a/score/component_example/docs/architecture/component_architecture.rst +++ b/score/component_example/docs/architecture/component_architecture.rst @@ -18,6 +18,7 @@ Component Architecture Documentation .. document:: [Your Component Name] Architecture :id: doc__mod_temp_component_name_architecture :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__component_arch diff --git a/score/component_example/docs/component_classification.rst b/score/component_example/docs/component_classification.rst index d24d826b..edbc15c6 100644 --- a/score/component_example/docs/component_classification.rst +++ b/score/component_example/docs/component_classification.rst @@ -20,6 +20,7 @@ Component Classification .. document:: [Your Component Name] Component Classification :id: doc__mod_temp_component_name_comp_class :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__sw_component_class diff --git a/score/component_example/docs/detailed_design/chklst_impl_inspection.rst b/score/component_example/docs/detailed_design/chklst_impl_inspection.rst index 21f31fcf..0079db07 100644 --- a/score/component_example/docs/detailed_design/chklst_impl_inspection.rst +++ b/score/component_example/docs/detailed_design/chklst_impl_inspection.rst @@ -15,6 +15,7 @@ .. document:: [Your Component Name] Implementation Inspection Checklist :id: doc__mod_temp_component_name_impl_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__sw_implementation_inspection diff --git a/score/component_example/docs/detailed_design/detailed_design_example.rst b/score/component_example/docs/detailed_design/detailed_design_example.rst index b0020704..70c4fed5 100644 --- a/score/component_example/docs/detailed_design/detailed_design_example.rst +++ b/score/component_example/docs/detailed_design/detailed_design_example.rst @@ -18,6 +18,7 @@ Example: Detailed Design .. document:: [Your Component Name] Detailed Design :id: doc__mod_temp_component_name_detailed_design :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__sw_implementation diff --git a/score/component_example/docs/index.rst b/score/component_example/docs/index.rst index 86ebabcb..2af7d709 100644 --- a/score/component_example/docs/index.rst +++ b/score/component_example/docs/index.rst @@ -22,6 +22,7 @@ .. document:: [Your Component Name] :id: doc__mod_temp_component_name :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__cmpt_request @@ -52,76 +53,12 @@ Abstract [A short (~200 word) description of the component.] -Rationale -========= - -[Describe why particular design decisions were made.] - -.. note:: - The rationale should provide evidence of consensus within the community and discuss important objections or concerns raised during discussion. - For the documentation of the decision the :need:`gd_temp__change_decision_record` can be used. - Specification ============= [Describe the requirements, architecture of any component.] or -Backwards Compatibility -======================= - -[Describe potential impact (especially including safety and security impacts) and severity on pre-existing platform/project elements.] - - -Security Impact -=============== - -[How could a malicious user take advantage of this new/modified component?] - -.. note:: - If there are security concerns in relation to the CR, those concerns should be explicitly written out to make sure reviewers of the CR are aware of them. - -Which security requirements are affected or has to be changed? -Could the new/modified component enable new threat scenarios? -Could the new/modified component enable new attack paths? -Could the new/modified component impact functional safety? -If applicable, which additional security measures must be implemented to mitigate the risk? - -.. note:: - Use Security Software Critically Analysis, Vulnerability Analysis. - [Methods will be defined later in Process area Security Analysis] - - -Safety Impact -============= - -[How could the safety be impacted by the new/modified component?] - -.. note:: - If there are safety concerns in relation to the CR, those concerns should be explicitly written out to make sure reviewers of the CR are aware of them. - -Which safety requirements are affected or has to be changed? -Could the new/modified component be a potential common cause or cascading failure initiator? -If applicable, which additional safety measures must be implemented to mitigate the risk? - -.. note:: - Use Dependency Failure Analysis and/or Safety Software Critically Analysis. - [Methods will be defined later in Process area Safety Analysis] - -For new feature/component contributions: - -[What is the expected ASIL level?] -[What is the expected classification of the contribution?] - -.. note:: - Use the component classification method here to classify your component, if it shall to be used in a safety context: :need:`gd_temp__component_classification`. - -License Impact -============== - -[How could the copyright impacted by the license of the new contribution?] - - How to Teach This ================= @@ -130,6 +67,7 @@ How to Teach This .. note:: For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work. + Rejected Ideas ============== @@ -142,19 +80,6 @@ Rejected Ideas In a way this section can be thought of as a breakout section of the Rationale section that is focused specifically on why certain ideas were not ultimately pursued. - -Open Issues -=========== - -[Any points that are still being decided/discussed.] - -.. note:: - While a CR is in draft, ideas can come up which warrant further discussion. - Those ideas should be recorded so people know that they are being thought about but do not have a concrete resolution. - This helps make sure all issues required for the CR to be ready for consideration are complete and reduces people duplicating prior discussion. - - - Footnotes ========= diff --git a/score/component_example/docs/requirements/requirements.rst b/score/component_example/docs/requirements/requirements.rst index 521ba1c3..314abcec 100644 --- a/score/component_example/docs/requirements/requirements.rst +++ b/score/component_example/docs/requirements/requirements.rst @@ -18,6 +18,7 @@ Component Requirements .. document:: [Your Component Name] Requirements :id: doc__mod_temp_component_name_requirements :status: draft + :version: 1 :safety: ASIL_B :security: YES :realizes: wp__requirements_comp[version==1] diff --git a/score/component_example/docs/safety_analysis/aou_requirements.rst b/score/component_example/docs/safety_analysis/aou_requirements.rst index 098b7029..03e1694b 100644 --- a/score/component_example/docs/safety_analysis/aou_requirements.rst +++ b/score/component_example/docs/safety_analysis/aou_requirements.rst @@ -18,6 +18,7 @@ AoU Component Requirements Template .. document:: [Your Component Name] Component AoU :id: doc__component_name_feat_aou :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__requirements_comp_aou diff --git a/score/component_example/docs/safety_analysis/dfa.rst b/score/component_example/docs/safety_analysis/dfa.rst index 08799a3f..cb888847 100644 --- a/score/component_example/docs/safety_analysis/dfa.rst +++ b/score/component_example/docs/safety_analysis/dfa.rst @@ -19,6 +19,7 @@ DFA (Dependent Failure Analysis) .. document:: [Your Component Name] DFA :id: doc__mod_temp_component_name_dfa :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__sw_component_dfa diff --git a/score/component_example/docs/safety_analysis/fmea.rst b/score/component_example/docs/safety_analysis/fmea.rst index 6fb93ca0..796f0010 100644 --- a/score/component_example/docs/safety_analysis/fmea.rst +++ b/score/component_example/docs/safety_analysis/fmea.rst @@ -19,6 +19,7 @@ FMEA (Failure Modes and Effects Analysis) .. document:: [Your Component Name] FMEA :id: doc__mod_temp_component_name_fmea :status: draft + :version: 1 :safety: ASIL_B :security: NO :realizes: wp__sw_component_fmea