Feature Template Update

docs/features/feature_example/architecture/chklst_arc_inspection.rst → docs/features/feature_example/architecture/arc_inspection.rst

@@ -12,8 +12,10 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+[Feature Name] Architecture Inspection
+======================================
 
-.. document:: [Your Feature Name] Architecture Inspection Checklist
+.. document:: [Feature Name] Architecture Inspection
    :id: doc__feature_name_arc_inspection
    :status: draft
    :version: 1
@@ -25,41 +27,55 @@
 .. attention::
     The above directive must be updated according to your Feature.
 
-    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``Feature Name`` to be your Feature Name
     - Modify ``id`` to be your Feature 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
-=================================
+Participants
+------------
 
-Purpose
--------
+.. note::
 
-The purpose of the software architecture checklist is to ensure that the design meets the criteria and quality as
-defined per project processes and guidelines for feature and component architectural design elements.
-It helps to check the compliance with requirements, identify errors or inconsistencies, and ensure adherence to best
-practices.
-The checklist guides evaluation of the architecture design, identifies potential problems, and aids in
-communication and documentation of architectural decisions to stakeholders.
+   As described in the concept :need:`doc_concept__wp_inspections` the following “inspection roles” are expected to be filled:
 
-Conduct
--------
+   * content responsible (author): <contributor/committer explicitly named here, who is the main author, as can be seen in config mgt tooling>
+   * reviewer: <contributor/committer explicitly named here, who is the main content reviewer, must be different from content responsible>
+   * moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection>
+
+
+.. list-table:: Architecture Inspection Participants
+    :header-rows: 1
+
+    * - Author(s)
+      - Reviewer(s)
+      - Moderator
+    * - `<https://github.com/NN>`_, `<https://github.com/NN>`_
+      - `<https://github.com/NN>`_, `<https://github.com/NN>`_
+      - `<https://github.com/NN>`_
+
+
+Architecture Inspection Checklist
+---------------------------------
 
-As described in the concept :need:`doc_concept__wp_inspections` the following "inspection roles" are expected to be filled:
+.. note::
 
-- content responsible (author): <contributor/committer explicitly named here, who is the main author, as can be seen in config mgt tooling>
-- reviewer: <contributor/committer explicitly named here, who is the main content reviewer, must be different from content responsible>
-- moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection>
+   **Purpose**
 
-Checklist
----------
+   The purpose of the software architecture checklist is to ensure that the design meets the criteria and quality
+   as defined per project processes and guidelines for feature and component architectural design elements.
+   It helps to check the compliance with requirements, identify errors or inconsistencies, and ensure adherence to best practices.
+   The checklist guides evaluation of the architecture design, identifies potential problems, and aids in communication and
+   documentation of architectural decisions to stakeholders.
 
-It is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additionally to add in the remarks why it is passed or not passed.
-In case of "no" an issue link to the issue tracking system has to be added in the last column (if not solved in the same issue).
-See also :need:`doc_concept__wp_inspections` for further information about reviews in general and inspection in particular.
+   **Checklist**
 
-.. list-table:: Architecture Design Review Checklist
+   It is mandatory to fill in the “passed” column with “yes” or “no” for each checklist item and additionally to add in the remarks why it is passed or not passed.
+   In case of “no” an issue link to the issue tracking system has to be added in the last column (if not solved in the same issue).
+   If a Review ID is not applicable for your architecture, then state ""n/a" in status and comment accordingly in remarks.
+   See also :need:`doc_concept__wp_inspections` for further information about reviews in general and inspection in particular.
+
+.. list-table:: Architecture Inspection Checklist
     :header-rows: 1
 
     * - Review Id
@@ -187,10 +203,15 @@ See also :need:`doc_concept__wp_inspections` for further information about revie
       -
 
 
-.. attention::
-    The above checklist entries must be filled according to your feature architecture in scope.
+Summary
+-------
+
+.. note::
+
+   The filtering must be updated according to your Feature.
 
-Note: If a Review ID is not applicable for your architecture, then state ""n/a" in status and comment accordingly in remarks.
+Inspected Static Architecture Views
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The following static views in "valid" state and with "inspected" tag set are in the scope of this inspection:
 
@@ -203,7 +224,10 @@ The following static views in "valid" state and with "inspected" tag set are in
    :colwidths: 25,25,25
    :sort: title
 
-and the following dynamic views:
+Inspected Dynamic Architecture Views
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+and the following dynamic views "valid" state and with "inspected" tag set are in the scope of this inspection:
 
 .. needtable::
    :filter: "feature_name" in docname and "architecture" in docname and docname is not None and status == "valid"
@@ -213,8 +237,3 @@ and the following dynamic views:
    :columns: id;status;tags
    :colwidths: 25,25,25
    :sort: title
-
-.. attention::
-    The above tables filtering must be updated according to your Feature.
-
-    - Modify ``feature_name`` to be your Feature Name in lower snake case

docs/features/feature_example/architecture/index.rst

@@ -12,10 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _feature_architecture_template:
-
-Feature Architecture
-====================
+[Feature Name] Architecture
+===========================
 
 .. document:: [Your Feature Name] Architecture
    :id: doc__feature_example_architecture
@@ -29,8 +27,8 @@ Feature Architecture
 .. 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 ``_architecture``
+    - Modify ``Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Feature Name in lower snake case preceded by ``doc__`` and followed by ``_architecture``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety``, ``security``  and ``tags`` according to your needs
 

docs/features/feature_example/index.rst

@@ -12,21 +12,16 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-[Your Feature Name]
-###################
+[Feature Name]
+##############
 
-Abstract
-========
-
-[A short (~200 word) description of the feature.]
-
-For the main feature description and requirements, see the belonging `Feature <https://eclipse-score.github.io/score/main/features/index.html#features>`_ in the project repository.
+Feature description and requirements can be found in the SCORE Platform.
 
 .. toctree::
    :hidden:
 
    architecture/index.rst
-   architecture/chklst_arc_inspection.rst
+   architecture/arc_inspection.rst
    safety_analysis/fmea.rst
    safety_analysis/dfa.rst
    safety_analysis/aou_requirements.rst

docs/features/feature_example/safety_analysis/aou_requirements.rst

@@ -12,10 +12,10 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-AoU Feature Requirements
-========================
+[Feature Name] Assumptions of Use
+=================================
 
-.. document:: [Your Feature Name] Feature AoU
+.. document:: [Feature Name] Feature AoU
    :id: doc__feature_name_feat_aou
    :status: draft
    :version: 1
@@ -28,17 +28,14 @@ AoU Feature Requirements
 .. 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``
+    - Modify ``Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Feature Name in lower 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.
-
-Feature AoU
------------
+AoU
+---
 
 .. code-block:: rst
 

docs/features/feature_example/safety_analysis/dfa.rst

@@ -13,10 +13,10 @@
    # *******************************************************************************
 
 
-DFA (Dependent Failure Analysis)
-================================
+[Feature Name] Dependent Failure Analysis
+=========================================
 
-.. document:: [Your Feature Name] DFA
+.. document:: [Feature Name] DFA
    :id: doc__feature_name_dfa
    :status: draft
    :version: 1
@@ -30,12 +30,12 @@ DFA (Dependent Failure Analysis)
 .. 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 succeeded by ``_dfa``
+    - Modify ``Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Feature Name in lower snake case preceded by ``doc__`` and succeeded by ``_dfa``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 
-The DFA for the feature [Your Feature Name] is performed. To show evidence that all failure initiators are considered, the applicability has to be filled out in the
+The DFA for the feature [Feature Name] is performed. To show evidence that all failure initiators are considered, the applicability has to be filled out in the
 following tables. For all applicable failure initiators, the DFA has to be performed.
 
 Dependent Failure Initiators

docs/features/feature_example/safety_analysis/fmea.rst

@@ -13,10 +13,10 @@
    # *******************************************************************************
 
 
-FMEA (Failure Modes and Effects Analysis)
-=========================================
+[Feature Name] Failure Modes and Effects Analysis
+=================================================
 
-.. document:: [Your Feature Name] FMEA
+.. document:: [Feature Name] FMEA
    :id: doc__feature_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 Feature.
 
-    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``Feature Name`` to be your Feature Name
     - Modify ``id`` to be your Feature 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

docs/features/feature_example/safety_planning/index.rst

@@ -12,12 +12,12 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _feature_safety_wp_template:
 
-Feature Safety Work Products List
-#################################
 
-.. document:: [Your Feature Name] Safety WPs
+[Feature Name] Safety Work Products List
+########################################
+
+.. document:: [Feature Name] Safety WPs
    :id: doc__feature_example_safety_wp
    :status: draft
    :version: 1
@@ -29,7 +29,7 @@ Feature Safety Work Products List
 .. attention::
     The above directive must be updated according to your Feature.
 
-    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``Feature Name`` to be your Feature Name
     - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc__`` and succeeded by ``_safety_wp``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
@@ -44,10 +44,10 @@ Additional to the tailoring in the SW platform project as defined in the project
   - <work product/requirement> - <Argumentation why it is not needed or replaced by another work product or activity.>
 
 
-Safety Work products List
+Safety Work Products List
 =========================
 
-.. list-table:: Feature <feature_name> Work products
+.. list-table:: [Feature Name] Safety Work products
     :header-rows: 1
 
     * - Work product Id

docs/features/feature_example/security_planning/index.rst

@@ -12,12 +12,10 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _feature_security_planning_template:
+[Feature Name] Security Work Products List
+##########################################
 
-Feature Security Work Products List
-###################################
-
-.. document:: [Your Feature Name] Security WPs
+.. document:: [Feature Name] Security WPs
    :id: doc__feature_example_security_planning_wp
    :status: draft
    :version: 1
@@ -29,7 +27,7 @@ Feature Security Work Products List
 .. attention::
     The above directive must be updated according to your Feature.
 
-    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``Feature Name`` to be your Feature Name
     - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc__`` and succeeded by ``_security_wp``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
@@ -44,10 +42,10 @@ Additional to the tailoring in the SW platform project as defined in the project
   - <work product/requirement> - <Argumentation why it is not needed or replaced by another work product or activity.>
 
 
-Security Work products List
+Security Work Products List
 ===========================
 
-.. list-table:: Feature <feature_name> Work products
+.. list-table:: [Feature Name] Security Work products
     :header-rows: 1
 
     * - Work product Id