cleanup templates (eclipse-score#198)

Author: PandaeDo

docs/module/manuals/safety_manual.rst

@@ -30,7 +30,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name or put "Platform"
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc__`` and succeeded by ``safety_manual``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_safety_manual``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 
@@ -106,5 +106,5 @@ Safety Anomalies
 
 References
 ----------
-| <link to the user manual>
+| :need:`doc__mod_temp_module_name_user_manual`
 | <other links>

docs/module/manuals/security_manual.rst

@@ -30,7 +30,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc__`` and succeeded by ``_security_manual``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_security_manual``
     - Adjust ``status`` to be ``valid``
     - Adjust ``security`` and ``tags`` according to your needs
 
@@ -98,5 +98,5 @@ Security Weaknesses, Vulnerabilities
 
 References
 ----------
-| <link to the user manual>
+| :need:`doc__mod_temp_module_name_user_manual`
 | <other links>

docs/module/manuals/user_manual.rst

@@ -18,16 +18,21 @@
 =========================
 
 .. document:: [Module Name] User Manual
-   :id: doc__user_manual
+   :id: doc__mod_temp_module_name_user_manual
    :status: draft
    :version: 1
    :safety: QM
    :security: NO
    :realizes: wp__module_user_manual[version==1]
-
+   :tags: template
 
 .. attention::
-    Update the document metadata according to your needs.
+    The above directive must be updated according to your Module.
+
+    - Modify ``Your Module Name`` to be your Module Name
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_user_manual``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety``, ``security`` and ``tags`` according to your needs
 
 Overview
 ========

docs/module/release/release_note.rst

@@ -30,7 +30,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc_`` and succeeded by ``release_note``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_release_note``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 

docs/module/safety_mgt/module_safety_analysis_fdr.rst

@@ -29,7 +29,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_safety _analysis_fdr``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_safety_analysis_fdr``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety``, ``security`` and ``tags`` according to your needs
 

docs/module/safety_mgt/module_safety_package_fdr.rst

@@ -30,7 +30,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc_`` and succeeded by ``safety_package_fdr``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_safety_package_fdr``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 

docs/module/safety_mgt/module_safety_plan.rst

@@ -30,7 +30,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc_`` and succeeded by ``safety_plan``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_safety_plan``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 
@@ -133,6 +133,11 @@ Module Work products List
           - :ndf:`copy('status', need_id='gd_temp__rel_mod_rel_note')`
           - :need:`doc__mod_temp_module_name_release_note`
 
+        * - :need:`wp__module_user_manual`
+          - :need:`gd_temp__rel_mod_user_manual`
+          - :ndf:`copy('status', need_id='gd_temp__rel_mod_user_manual')`
+          - :need:`doc__mod_temp_module_name_user_manual`
+
 Component <name> Work products List
 -----------------------------------
 

docs/module/safety_mgt/module_safety_plan_fdr.rst

@@ -30,7 +30,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc_`` and succeeded by ``safety_plan_fdr``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_safety_plan_fdr``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 

docs/module/security_mgt/module_security_package_fdr.rst

@@ -23,14 +23,14 @@
   :version: 1
   :safety: ASIL_B
   :security: YES
-  :realizes: wp__fdr_reports
+  :realizes: wp__fdr_reports_security
   :tags: template
 
 .. attention::
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc_`` and succeeded by ``safety_package_fdr``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_sec_pkg_fdr``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 

docs/module/security_mgt/module_security_plan.rst

@@ -30,7 +30,7 @@
     The above directive must be updated according to your Module.
 
     - Modify ``Your Module Name`` to be your Module Name
-    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc_`` and succeeded by ``security_plan``
+    - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_security_plan``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs
 
@@ -83,21 +83,21 @@
           - <Link to WP>
           - <automated>
 
-        * - :need:`wp__fdr_reports` (Module Security Plan)
+        * - :need:`wp__fdr_reports_security` (Module Security Plan)
           - :need:`gd_chklst__security_plan`
           - <automated>
           - <Link to issue>
           - <Link to WP>
           - <automated>
 
-        * - :need:`wp__fdr_reports` (Module Security Package)
+        * - :need:`wp__fdr_reports_security` (Module Security Package)
           - :need:`Security Package Formal Review Checklist <gd_chklst__security_package>`
           - <automated>
           - <Link to issue>
           - <Link to WP>
           - <automated>
 
-        * - :need:`wp__fdr_reports` (Module's Security Analyses)
+        * - :need:`wp__fdr_reports_security` (Module's Security Analyses)
           - Security Analysis FDR tbd
           - <automated>
           - <Link to issue>
@@ -132,6 +132,13 @@
           - <Link to WP>
           - <automated>
 
+        * - :need:`wp__module_user_manual`
+          - :need:`gd_temp__rel_mod_user_manual`
+          - <automated>
+          - <Link to issue>
+          - :need:`doc__mod_temp_module_name_user_manual`
+          - <automated>
+
         * - :need:`wp__sw_module_sbom`
           - Security management guidance
           - not started