From 4f94262400b188053f3f3bc8c20a9d83b366bacf Mon Sep 17 00:00:00 2001 From: PandaeDo Date: Fri, 3 Jul 2026 12:17:20 +0200 Subject: [PATCH 1/3] fix formatting --- .../docs/architecture/component_architecture.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/score/component_example/docs/architecture/component_architecture.rst b/score/component_example/docs/architecture/component_architecture.rst index 41d2de85..322ad5bd 100644 --- a/score/component_example/docs/architecture/component_architecture.rst +++ b/score/component_example/docs/architecture/component_architecture.rst @@ -147,3 +147,4 @@ Internal Components - Replace the example content by the real content (according to :need:`gd_guidl__arch_design`) - Set the status to valid and start the review/merge process + From fcb5aef1689b2657b973375848f55dec1d920ae7 Mon Sep 17 00:00:00 2001 From: PandaeDo Date: Fri, 3 Jul 2026 16:40:11 +0200 Subject: [PATCH 2/3] update template --- .../docs/architecture/component_architecture.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/score/component_example/docs/architecture/component_architecture.rst b/score/component_example/docs/architecture/component_architecture.rst index 322ad5bd..41d2de85 100644 --- a/score/component_example/docs/architecture/component_architecture.rst +++ b/score/component_example/docs/architecture/component_architecture.rst @@ -147,4 +147,3 @@ Internal Components - Replace the example content by the real content (according to :need:`gd_guidl__arch_design`) - Set the status to valid and start the review/merge process - From 3e11f4b53f8a92f7345b9d13be41c35c2a3ac403 Mon Sep 17 00:00:00 2001 From: PandaeDo Date: Tue, 18 Aug 2026 14:05:25 +0200 Subject: [PATCH 3/3] alignment headline style --- docs/features/feature_example/architecture/index.rst | 2 +- docs/module/manuals/safety_manual.rst | 6 +++--- docs/module/manuals/security_manual.rst | 6 +++--- docs/module/manuals/user_manual.rst | 6 +++--- docs/module/release/release_note.rst | 6 +++--- docs/module/safety_mgt/module_safety_analysis_fdr.rst | 6 +++--- docs/module/safety_mgt/module_safety_package_fdr.rst | 6 +++--- docs/module/safety_mgt/module_safety_plan.rst | 6 +++--- docs/module/safety_mgt/module_safety_plan_fdr.rst | 6 +++--- .../security_mgt/module_security_package_fdr.rst | 6 +++--- docs/module/security_mgt/module_security_plan.rst | 6 +++--- docs/module/security_mgt/module_security_plan_fdr.rst | 6 +++--- .../module_verification_report.rst | 2 +- .../docs/architecture/chklst_arc_inspection.rst | 8 ++++---- .../docs/architecture/component_architecture.rst | 8 ++++---- score/component_example/docs/architecture/index.rst | 4 ++-- .../docs/component_classification.rst | 8 ++++---- .../docs/detailed_design/chklst_impl_inspection.rst | 8 ++++---- .../docs/detailed_design/detailed_design_example.rst | 11 +++++------ .../component_example/docs/detailed_design/index.rst | 4 ++-- .../docs/requirements/chklst_req_inspection.rst | 8 ++++---- score/component_example/docs/requirements/index.rst | 4 ++-- .../docs/requirements/requirements.rst | 6 +++--- .../docs/safety_analysis/aou_requirements.rst | 8 ++++---- score/component_example/docs/safety_analysis/dfa.rst | 8 ++++---- score/component_example/docs/safety_analysis/fmea.rst | 8 ++++---- 26 files changed, 81 insertions(+), 82 deletions(-) diff --git a/docs/features/feature_example/architecture/index.rst b/docs/features/feature_example/architecture/index.rst index 7804ab05..9c275729 100644 --- a/docs/features/feature_example/architecture/index.rst +++ b/docs/features/feature_example/architecture/index.rst @@ -15,7 +15,7 @@ [Feature Name] Architecture =========================== -.. document:: [Your Feature Name] Architecture +.. document:: [Feature Name] Architecture :id: doc__feature_example_architecture :status: draft :version: 1 diff --git a/docs/module/manuals/safety_manual.rst b/docs/module/manuals/safety_manual.rst index 372b8d16..b0545108 100644 --- a/docs/module/manuals/safety_manual.rst +++ b/docs/module/manuals/safety_manual.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Safety Manual -============= +[Module Name] Safety Manual +=========================== .. note:: Document header -.. document:: [Your Module Name] Safety Manual +.. document:: [Module Name] Safety Manual :id: doc__mod_temp_module_name_safety_manual :status: draft :version: 1 diff --git a/docs/module/manuals/security_manual.rst b/docs/module/manuals/security_manual.rst index b3b5e1b4..95e05d1b 100644 --- a/docs/module/manuals/security_manual.rst +++ b/docs/module/manuals/security_manual.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Security Manual -=============== +[Module Name] Security Manual +============================= .. note:: Document header -.. document:: [Your Module Name] Security Manual +.. document:: [Module Name] Security Manual :id: doc__mod_temp_module_name_security_manual :status: draft :version: 1 diff --git a/docs/module/manuals/user_manual.rst b/docs/module/manuals/user_manual.rst index a2564fd9..9b9fa1ef 100644 --- a/docs/module/manuals/user_manual.rst +++ b/docs/module/manuals/user_manual.rst @@ -14,10 +14,10 @@ .. _user_manual: -User Manual -########### +[Module Name] User Manual +========================= -.. document:: User Manual +.. document:: [Module Name] User Manual :id: doc__user_manual :status: draft :version: 1 diff --git a/docs/module/release/release_note.rst b/docs/module/release/release_note.rst index 06ba2c35..b4373f12 100644 --- a/docs/module/release/release_note.rst +++ b/docs/module/release/release_note.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Release Note -============ +[Module Name] Release Note +========================== .. note:: Document header -.. document:: [Your Module Name] Release Note +.. document:: [Module Name] Release Note :id: doc__mod_temp_module_name_release_note :status: draft :version: 1 diff --git a/docs/module/safety_mgt/module_safety_analysis_fdr.rst b/docs/module/safety_mgt/module_safety_analysis_fdr.rst index a0df35e2..a56cad61 100644 --- a/docs/module/safety_mgt/module_safety_analysis_fdr.rst +++ b/docs/module/safety_mgt/module_safety_analysis_fdr.rst @@ -13,10 +13,10 @@ # ******************************************************************************* -Safety Analysis Checklist -========================= +[Module Name] Safety Analysis Checklist +======================================= -.. document:: [Your Module Name] Safety Analysis Checklist +.. document:: [Module Name] Safety Analysis Checklist :id: doc__mod_temp_module_name_safety_analysis_fdr :status: draft :version: 1 diff --git a/docs/module/safety_mgt/module_safety_package_fdr.rst b/docs/module/safety_mgt/module_safety_package_fdr.rst index 2e5adcdf..ddaec272 100644 --- a/docs/module/safety_mgt/module_safety_package_fdr.rst +++ b/docs/module/safety_mgt/module_safety_package_fdr.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Safety Package Formal Review Report -=================================== +[Module Name] Safety Package Formal Review Report +================================================= .. note:: Document header -.. document:: [Your Module Name] Safety Package Formal Review +.. document:: [Module Name] Safety Package Formal Review :id: doc__mod_temp_module_name_safety_package_fdr :status: draft :version: 1 diff --git a/docs/module/safety_mgt/module_safety_plan.rst b/docs/module/safety_mgt/module_safety_plan.rst index fd7bd48c..033fc8bd 100644 --- a/docs/module/safety_mgt/module_safety_plan.rst +++ b/docs/module/safety_mgt/module_safety_plan.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Safety Plan -*********** +[Module Name] Safety Plan +========================= .. note:: Document header -.. document:: [Your Module Name] Safety Plan +.. document:: [Module Name] Safety Plan :id: doc__mod_temp_module_name_safety_plan :status: draft :version: 1 diff --git a/docs/module/safety_mgt/module_safety_plan_fdr.rst b/docs/module/safety_mgt/module_safety_plan_fdr.rst index 3a594714..a13861d6 100644 --- a/docs/module/safety_mgt/module_safety_plan_fdr.rst +++ b/docs/module/safety_mgt/module_safety_plan_fdr.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Safety Plan Formal Review Report -================================ +[Module Name] Safety Plan Formal Review Report +============================================== .. note:: Document header -.. document:: [Your Module Name] Safety Plan Formal Review +.. document:: [Module Name] Safety Plan Formal Review :id: doc__mod_temp_module_name_safety_plan_fdr :status: draft :version: 1 diff --git a/docs/module/security_mgt/module_security_package_fdr.rst b/docs/module/security_mgt/module_security_package_fdr.rst index be86b322..0feef1fa 100644 --- a/docs/module/security_mgt/module_security_package_fdr.rst +++ b/docs/module/security_mgt/module_security_package_fdr.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Security Package Formal Review Report -===================================== +[Module Name] Security Package Formal Review Report +=================================================== .. note:: Document header -.. document:: [Your Module Name] Security Package Formal Review +.. document:: [Module Name] Security Package Formal Review :id: doc__mod_temp_module_name_sec_pkg_fdr :status: draft :version: 1 diff --git a/docs/module/security_mgt/module_security_plan.rst b/docs/module/security_mgt/module_security_plan.rst index 628b1c3b..b3ce3e3f 100644 --- a/docs/module/security_mgt/module_security_plan.rst +++ b/docs/module/security_mgt/module_security_plan.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Security Plan -============= +[Module Name] Security Plan +=========================== .. note:: Document header -.. document:: [Your Module Name] Security Plan +.. document:: [Module Name] Security Plan :id: doc__mod_temp_module_name_security_plan :status: draft :version: 1 diff --git a/docs/module/security_mgt/module_security_plan_fdr.rst b/docs/module/security_mgt/module_security_plan_fdr.rst index 1be77a04..fe86db37 100644 --- a/docs/module/security_mgt/module_security_plan_fdr.rst +++ b/docs/module/security_mgt/module_security_plan_fdr.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Security Plan Formal Review Report -================================== +[Module Name] Security Plan Formal Review Report +================================================ .. note:: Document header -.. document:: [Your Module Name] Security Plan Formal Review +.. document:: [Module Name] Security Plan Formal Review :id: doc__mod_temp_module_name_security_plan_fdr :status: draft :version: 1 diff --git a/docs/verification_report/module_verification_report.rst b/docs/verification_report/module_verification_report.rst index b0f96b52..500a2a7a 100644 --- a/docs/verification_report/module_verification_report.rst +++ b/docs/verification_report/module_verification_report.rst @@ -17,7 +17,7 @@ Verification Report .. note:: Document header -.. document:: [Your Module Name] Verification Report +.. document:: [Module Name] Verification Report :id: doc__mod_temp_module_name_verification_report :status: draft :version: 1 diff --git a/score/component_example/docs/architecture/chklst_arc_inspection.rst b/score/component_example/docs/architecture/chklst_arc_inspection.rst index d6debef0..6f98d1ce 100644 --- a/score/component_example/docs/architecture/chklst_arc_inspection.rst +++ b/score/component_example/docs/architecture/chklst_arc_inspection.rst @@ -13,7 +13,7 @@ # ******************************************************************************* -.. document:: [Your Component Name] Architecture Inspection Checklist +.. document:: [Component Name] Architecture Inspection Checklist :id: doc__mod_temp_component_name_arc_inspection :status: draft :version: 1 @@ -25,13 +25,13 @@ .. attention:: The above directive must be updated according to your component. - - Modify ``Your Component Name`` to be your component Name + - Modify ``Component Name`` to be your component Name - Modify ``id`` to be your component Name in lower snake case preceded by ``doc__`` and followed by ``_arc_inspection`` - Adjust ``status`` to be ``valid`` - Adjust ``safety``, ``security`` and ``tags`` according to your needs -Architecture Inspection Checklist -================================= +[Component Name] Architecture Inspection Checklist +================================================== Purpose ------- diff --git a/score/component_example/docs/architecture/component_architecture.rst b/score/component_example/docs/architecture/component_architecture.rst index 41d2de85..a8813a2f 100644 --- a/score/component_example/docs/architecture/component_architecture.rst +++ b/score/component_example/docs/architecture/component_architecture.rst @@ -14,10 +14,10 @@ .. _component_architecture: -Component Architecture Documentation -==================================== +[Component Name] Component Architecture Documentation +===================================================== -.. document:: [Your Component Name] Architecture +.. document:: [Component Name] Architecture :id: doc__mod_temp_component_name_architecture :status: draft :version: 1 @@ -29,7 +29,7 @@ Component Architecture Documentation .. attention:: The above directive must be updated according to your needs. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component 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 diff --git a/score/component_example/docs/architecture/index.rst b/score/component_example/docs/architecture/index.rst index 3ea0100b..1f378c72 100644 --- a/score/component_example/docs/architecture/index.rst +++ b/score/component_example/docs/architecture/index.rst @@ -14,8 +14,8 @@ .. _component_architecture_template: -Component Architecture -====================== +[Component Name] Component Architecture +======================================= .. toctree:: diff --git a/score/component_example/docs/component_classification.rst b/score/component_example/docs/component_classification.rst index edbc15c6..8a2371e4 100644 --- a/score/component_example/docs/component_classification.rst +++ b/score/component_example/docs/component_classification.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Component Classification -======================== +[Component Name] Component Classification +========================================= .. note:: Document header -.. document:: [Your Component Name] Component Classification +.. document:: [Component Name] Component Classification :id: doc__mod_temp_component_name_comp_class :status: draft :version: 1 @@ -29,7 +29,7 @@ Component Classification .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` - Adjust ``status`` to be ``valid`` - Adjust ``safety`` and ``tags`` according to your needs 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 0079db07..47d7a7e0 100644 --- a/score/component_example/docs/detailed_design/chklst_impl_inspection.rst +++ b/score/component_example/docs/detailed_design/chklst_impl_inspection.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. document:: [Your Component Name] Implementation Inspection Checklist +.. document:: [Component Name] Implementation Inspection Checklist :id: doc__mod_temp_component_name_impl_inspection :status: draft :version: 1 @@ -24,13 +24,13 @@ .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in lower snake case preceded by ``doc__`` and followed by ``_impl_inspection`` - Adjust ``status`` to be ``valid`` - Adjust ``safety``, ``security`` and ``tags`` according to your needs -Implementation Inspection Checklist -=================================== +[Component Name] Implementation Inspection Checklist +==================================================== Purpose ------- 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 2a2b379b..cd254427 100644 --- a/score/component_example/docs/detailed_design/detailed_design_example.rst +++ b/score/component_example/docs/detailed_design/detailed_design_example.rst @@ -14,10 +14,10 @@ .. _detailed_design_example: -Example: Detailed Design -======================== +[Component Name] Detailed Design +================================ -.. document:: [Your Component Name] Detailed Design +.. document:: [Component Name] Detailed Design :id: doc__mod_temp_component_name_detailed_design :status: draft :version: 1 @@ -29,13 +29,12 @@ Example: Detailed Design .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_detailed_design`` - Adjust ``status`` to be ``valid`` - Adjust ``safety`` and ``tags`` according to your needs -Detailed Design for Component: -=============================================== + Description ----------- diff --git a/score/component_example/docs/detailed_design/index.rst b/score/component_example/docs/detailed_design/index.rst index 61199c52..97563edd 100644 --- a/score/component_example/docs/detailed_design/index.rst +++ b/score/component_example/docs/detailed_design/index.rst @@ -14,8 +14,8 @@ .. _component_detailed_design_template: -Detailed Design -############### +[Component Name] Detailed Design +================================ .. attention:: diff --git a/score/component_example/docs/requirements/chklst_req_inspection.rst b/score/component_example/docs/requirements/chklst_req_inspection.rst index 07ab8a88..1f3278b8 100644 --- a/score/component_example/docs/requirements/chklst_req_inspection.rst +++ b/score/component_example/docs/requirements/chklst_req_inspection.rst @@ -13,7 +13,7 @@ # ******************************************************************************* -.. document:: [Your Component Name] Requirements Inspection Checklist +.. document:: [Component Name] Requirements Inspection Checklist :id: doc__mod_temp_component_name_req_inspection :status: draft :version: 2 @@ -25,13 +25,13 @@ .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in lower snake case preceded by ``doc__`` and followed by ``_req_inspection`` - Adjust ``status`` to be ``valid`` - Adjust ``safety``, ``security`` and ``tags`` according to your needs -Requirement Inspection Checklist -================================ +[Component Name] Requirement Inspection Checklist +================================================= Purpose ------- diff --git a/score/component_example/docs/requirements/index.rst b/score/component_example/docs/requirements/index.rst index 9eea1fc7..b42a50ac 100644 --- a/score/component_example/docs/requirements/index.rst +++ b/score/component_example/docs/requirements/index.rst @@ -12,8 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Requirements -############ +[Component Name] Requirements +============================= .. toctree:: diff --git a/score/component_example/docs/requirements/requirements.rst b/score/component_example/docs/requirements/requirements.rst index 4967cfe9..37380e60 100644 --- a/score/component_example/docs/requirements/requirements.rst +++ b/score/component_example/docs/requirements/requirements.rst @@ -12,10 +12,10 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Component Requirements +[Component Name] Requirements ############################# -.. document:: [Your Component Name] Requirements +.. document:: [Component Name] Requirements :id: doc__mod_temp_component_name_requirements :status: draft :version: 1 @@ -27,7 +27,7 @@ Component Requirements .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_requirements`` - Adjust ``status`` to be ``valid`` - Adjust ``safety``, ``security`` and ``tags`` according to your needs diff --git a/score/component_example/docs/safety_analysis/aou_requirements.rst b/score/component_example/docs/safety_analysis/aou_requirements.rst index 03e1694b..1d89532d 100644 --- a/score/component_example/docs/safety_analysis/aou_requirements.rst +++ b/score/component_example/docs/safety_analysis/aou_requirements.rst @@ -12,10 +12,10 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -AoU Component Requirements Template -=================================== +[Component Name] AoU Component Requirements Template +==================================================== -.. document:: [Your Component Name] Component AoU +.. document:: [Component Name] Component AoU :id: doc__component_name_feat_aou :status: draft :version: 1 @@ -28,7 +28,7 @@ AoU Component Requirements Template .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``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 diff --git a/score/component_example/docs/safety_analysis/dfa.rst b/score/component_example/docs/safety_analysis/dfa.rst index cb888847..3215220a 100644 --- a/score/component_example/docs/safety_analysis/dfa.rst +++ b/score/component_example/docs/safety_analysis/dfa.rst @@ -13,10 +13,10 @@ # ******************************************************************************* -DFA (Dependent Failure Analysis) -================================ +[Component Name] DFA (Dependent Failure Analysis) +================================================= -.. document:: [Your Component Name] DFA +.. document:: [Component Name] DFA :id: doc__mod_temp_component_name_dfa :status: draft :version: 1 @@ -30,7 +30,7 @@ DFA (Dependent Failure Analysis) .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and succeeded by ``_dfa`` - Adjust ``status`` to be ``valid`` - Adjust ``safety`` and ``tags`` according to your needs diff --git a/score/component_example/docs/safety_analysis/fmea.rst b/score/component_example/docs/safety_analysis/fmea.rst index 796f0010..fe40f187 100644 --- a/score/component_example/docs/safety_analysis/fmea.rst +++ b/score/component_example/docs/safety_analysis/fmea.rst @@ -13,10 +13,10 @@ # ******************************************************************************* -FMEA (Failure Modes and Effects Analysis) -========================================= +[Component Name] FMEA (Failure Modes and Effects Analysis) +========================================================== -.. document:: [Your Component Name] FMEA +.. document:: [Component Name] FMEA :id: doc__mod_temp_component_name_fmea :status: draft :version: 1 @@ -30,7 +30,7 @@ FMEA (Failure Modes and Effects Analysis) .. attention:: The above directive must be updated according to your Component. - - Modify ``Your Component Name`` to be your Component Name + - Modify ``Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and succeeded by ``_fmea`` - Adjust ``status`` to be ``valid`` - Adjust ``safety`` and ``tags`` according to your needs