Merge pull request #465 from qorix-group/vohae_improvement_implementation

Improvement: Implementation process description ML#2

Author: PhilipPartsch

process/folder_templates/modules/module_name/component_name/docs/detailed_design/index.rst

@@ -55,25 +55,104 @@ Static Diagrams for Unit Interactions
 .. code-block:: rst
 
    .. dd_sta:: <Title>
-      :id: dd_sta__<Feature>__<Title>
+      :id: dd_sta__<Component>__<Title>
       :security: <YES|NO>
       :safety: <QM|ASIL_B>
       :status: <valid|invalid>
       :implements: <link to component requirement id>
       :satisfies: <link to component architecture id>
+      :belongs_to: <link to component id>
+      :includes: <link to sw_unit id>, <link to sw_unit interface id>
 
-        .. image:: <link to drawio image> or .. uml:: <link to plantuml>
+      .. needarch:: or .. image:: <link to drawio image>
 
 Dynamic Diagrams for Unit Interactions
 --------------------------------------
 .. code-block:: rst
 
    .. dd_dyn:: <Title>
-      :id: dd_dyn__<Feature>__<Title>
+      :id: dd_dyn__<Component>__<Title>
       :security: <YES|NO>
       :safety: <QM|ASIL_B>
       :status: <valid|invalid>
       :implements: <link to component requirement id>
       :satisfies: <link to component architecture id>
+      :belongs_to: <link to component id>
+      :includes: <link to sw_unit id>, <link to sw_unit interface id>
 
-        .. image:: <link to drawio image> or .. uml:: <link to plantuml>
+      .. needarch:: or .. image:: <link to drawio image>
+
+Units within the Component
+--------------------------
+
+In your rst file:
+
+.. code-block:: rst
+
+   .. sw_unit:: cpp unit
+      :id: sw_unit__<Component>__<title>
+      :belongs_to: <link to component id>
+
+      This implements the ....
+
+In your source file, any programming language, here with C++:
+
+.. code-block:: cpp
+
+   # need-Id: sw_unit__<Component>__<title>
+   class <class name> {
+      public:
+
+   };
+
+Interface View
+--------------
+
+In your rst file:
+
+.. code-block:: rst
+
+   .. sw_unit_int:: <here InterfaceDemo - change it>
+      :id: sw_unit_int__<Component>__<title>
+      :belongs_to: <link to sw_unit id>
+      :implements: <real_arc_int, real_arc_int_op>
+
+      This implements the ....
+
+In your source file, any programming language, here with C++:
+
+.. code-block:: cpp
+
+   # need-Id: sw_unit__<Component>__<title>
+   class InterfaceDemo
+   {
+      public:
+         virtual ~InterfaceDemo() {}
+         virtual void OverrideMe() = 0;
+   };
+
+-  For cpp using doxygen comments
+
+.. code-block:: cpp
+
+   /**
+      * @rst
+      * .. sw_unit_int:: cpp unit
+      *    :id: sw_unit_int__<Component>__<title>
+      *    :belongs_to: <link to sw_unit id>
+      *    :implements: <real_arc_int, real_arc_int_op>
+      *
+      *    This implements the ....
+      * @endrst
+   */
+
+-  For rust
+
+.. code-block:: rust
+
+   //! .. sw_unit_int:: rust unit
+   //!     :id: sw_unit_int__<Component>__<title>
+   //!     :belongs_to: <link to sw_unit id>
+   //!     :implements: <real_arc_int, real_arc_int_op>
+   //!
+   //!     This implements the ....

process/process_areas/implementation/guidance/implementation_guideline.rst

@@ -20,8 +20,8 @@ Guideline
    :status: valid
    :complies: std_req__iso26262__software_744
 
-This document describes the general guidances for implementation based on the concept which is defined :need:`[[title]]<doc_concept__imp_concept>`.
-In the concept is a example of a Detailed Design included.
+This document describes the general guidance for implementation based on the concept which is defined :need:`[[title]]<doc_concept__imp_concept>`.
+The concept includes an example of a Detailed Design.
 
 Workflow for Implementation
 ===========================
@@ -37,7 +37,7 @@ Detailed description which steps are need for implementation.
 #. Implement the source code, by using the coding guidelines given within the project specific :need:`SW development Plan <wp__sw_development_plan>` for the programming languages in your project.
 #. Create a pull request for your change.
 #. Detail Design and Code Inspection is done to review the code of the software and detect errors in it.
-#. Check the results of the static and dynamic code analysis (this inlcludes compiler warnings). Acceptance criteria are defined in the Verification Plan :need:`gd_temp__verification_plan`.
+#. Check the results of the static and dynamic code analysis (this includes compiler warnings). Acceptance criteria are defined in the Verification Plan :need:`gd_temp__verification_plan`.
 #. Fix or justify the errors.
 #. Merge the pull request.
 #. Create a follow up ticket if not all findings could be fixed.