WIP: Tool requirement updates

Also started to remove 'ASIL_D' from mentions

Author: MaximilianSoerenPollak

docs/how-to-integrate/example/index.rst

@@ -39,7 +39,7 @@ This is a rendered example of the 'examples/linking-both' folder using the `docs
    :id: tool_req__example__some_title
    :reqtype: Process
    :security: YES
-   :safety: ASIL_D
+   :safety: ASIL_B
    :satisfies: PROCESS_gd_req__req__attr_uid
    :status: invalid
 

docs/how-to-integrate/example/testing/index.rst

@@ -33,7 +33,7 @@ This example will help catch things and bugs when rst's are defined inside a fol
    :id: tool_req__testing__some_title
    :reqtype: Process
    :security: YES
-   :safety: ASIL_D
+   :safety: ASIL_B
    :satisfies: PROCESS_gd_req__req__attr_uid
    :status: invalid
 

docs/product/requirements.rst

@@ -137,6 +137,8 @@ This section provides an overview of current process requirements and their clar
   * all architecture elements defined in :need:`tool_req__docs_arch_types`.
 
 
+
+
 ---------------------------
 🛡️ Safety Classification
 ---------------------------
@@ -154,13 +156,23 @@ This section provides an overview of current process requirements and their clar
 
   * QM
   * ASIL_B
-  * ASIL_D
 
   This rule applies to:
 
   * all requirement types defined in :need:`tool_req__docs_req_types`, except process requirements.
   * all architecture elements defined in :need:`tool_req__docs_arch_types`.
 
+
+
+.. tool_req:: Safety: enforce safe linking
+   :id: tool_req__docs_common_attr_safety_link_check
+   :tags: Common Attributes
+   :implemented: YES
+   :parent_covered: YES
+   :satisfies: PROCESS_gd_req__req__linkage_safety     
+
+   
+
 ----------
 🚦 Status
 ----------
@@ -184,15 +196,55 @@ This section provides an overview of current process requirements and their clar
   * all requirement types defined in :need:`tool_req__docs_req_types`, except process requirements.
   * all architecture elements defined in :need:`tool_req__docs_arch_types`.
 
+
+
+
+----------
+Versioning
+----------
+
+.. tool_req:: Versioning: enforce attribute
+   :id: tool_req__docs_common_attr_version
+   :tags: Common Attributes
+   :implemented: NO
+   :parent_covered: YES
+   :satisfies: PROCESS_gd_req__req__attr_version
+   :status: valid
+
+   Docs-As-Code shall enable and enforce a verssioning attribute for requirements of type :need:`tool_req__docs_req_types`.
+   This versioning shall change if any of the following attributes changes: 
+
+   * Description 
+   * Rationale 
+   * Safety 
+   * Security 
+   * ID 
+   * Status 
+   * Reqtype
+   * Title
+
+      
+.. tool_req:: Suspicious: Enforce attribute
+   :id: tool_req__docs_common_attr_suspicous
+   :tags: Common Attributes
+   :implemented: NO
+   :parent_covered: YES
+   :satisfies: PROCESS_gd_req__req__attr_suspicious
+
+   Docs-as-Code shall check if linked parent requirements have differentiation versions, compared to the
+   versioning it was originaly linked too
+
+
+
+
 📚 Documents
 #############
 
 .. tool_req:: Document Types
   :id: tool_req__docs_doc_types
   :tags: Documents
   :implemented: YES
-
-  .. :satisfies: PROCESS_gd_req__doc_types (next process release)
+  :satisfies: PROCESS_gd_req__doc__types 
 
   Docs-as-Code shall support the following document types:
 
@@ -203,18 +255,17 @@ This section provides an overview of current process requirements and their clar
   :id: tool_req__docs_doc_attr
   :tags: Documents
   :implemented: NO
-  :satisfies:
-   PROCESS_gd_req__doc_author,
-   PROCESS_gd_req__doc_approver,
-   PROCESS_gd_req__doc_reviewer,
+  :satisfies: gd_req__doc__attributes_manual
   :parent_covered: NO
 
   Docs-as-Code shall enforce that each :need:`tool_req__docs_doc_types` has the
   following attributes:
 
-  * author
-  * approver
-  * reviewer
+  * id 
+  * status 
+  * safety 
+  * realizes 
+  * security
 
 
 .. tool_req:: Document author is autofilled
@@ -427,7 +478,7 @@ Architecture Attributes
    :id: tool_req__docs_arch_attr_mandatory
    :tags: Architecture
    :satisfies: PROCESS_gd_req__arch__attr_mandatory
-   :implemented: Partial
+   :implemented: PARTIAL
    :parent_covered: YES
    :parent_has_problem: YES: Metamodel & Process aren't the same. Some definitions are not consistent in Process
 
@@ -471,6 +522,7 @@ Architecture Attributes
    PROCESS_gd_req__arch__linkage_requirement_type,
    PROCESS_gd_req__arch__attr_fulfils,
    PROCESS_gd_req__arch__traceability,
+   PROCESS_gd_req__req__linkage_fulfill
   :parent_covered: YES
 
   Docs-as-Code shall enforce that linking via the ``fulfils`` attribute follows defined rules.
@@ -501,16 +553,17 @@ Architecture Attributes
   type :need:`tool_req__docs_req_types` that are also safety relevant (``safety !=
   QM``).
 
+
 .. tool_req:: Restrict links for safety requirements
   :id: tool_req__docs_req_arch_link_safety_to_arch
   :tags: Architecture
   :implemented: PARTIAL
-  :satisfies: PROCESS_gd_req__arch__linkage_safety_trace
+  :satisfies: PROCESS_gd_req__arch__linkage_safety_trace, PROCESS_gd_req__req__linkage_safety
   :parent_covered: NO
 
-  Docs-as-Code shall enforce that architecture model elements of type
+  Docs-as-Code shall enforce that `valid` architecture model elements of type
   :need:`tool_req__docs_arch_types` with ``safety != QM`` can only be linked to other
-  architecture model elements with ``safety != QM``.
+  `valid` architecture model elements with ``safety != QM``.
 
 .. tool_req:: Security: Restrict linkage
   :id: tool_req__docs_arch_link_security
@@ -553,31 +606,96 @@ Architecture Attributes
 .. tool_req:: Supports linking to source code
   :tags: Detailed Design & Code
   :id: tool_req__docs_dd_link_source_code_link
-  :implemented: PARTIAL
+  :implemented: YES
   :parent_covered: YES
-  :satisfies: PROCESS_gd_req__req__attr_impl
+  :satisfies: PROCESS_gd_req__req__attr_impl, PROCESS_gd_req__impl__design_code_link
 
-  Docs-as-Code shall allow source code to link to requirements.
+  Docs-as-Code shall allow source code to link to :need:`tool_req__docs_req_types` and :need:`tool_req__docs_doc_types`
 
   A backlink to the corresponding source code location in GitHub shall be generated in
   the output as an attribute of the linked requirement.
 
+
+
+
+.. tool_req:: Feature Flags
+   :id: tool_req__docs_dd_feature_flag
+   :tags: Detailed Design & Code
+   :implemented: NO
+   :parent_covered: YES
+   :satisfies: PROCESS_gd_req__req__linkage_architecture_switch
+
+   Docs-as-Code shall allow for singular or multiple checks to be disabled for non release builds
+
+
+.. Unsure if this is 'detailed design'
+.. tool_req:: Enable Creation of Dependcy Graphs
+   :id: tool_req__docs__dd_dependency_graph
+   :tags: Detailed Design & Code
+   :implemented: NO
+   :parent_covered: YES
+   :satisfies: PROCESS_gd_req__impl__dependency_analysis
+   :status: invalid
+
+   Docs-As-Code shall provide a way to create dependency graphs. It shall show the whole dependencies, from the libraries 
+   used, to the leaves of the dependency tree.
+
+   .. warning:: 
+      Unclear what output format to use, and if it needs to be rendered in documentation, or just is extra asset.
+
+   
+Testing
+#######
+
+
 .. tool_req:: Supports linking to test cases
-  :id: tool_req__docs_dd_link_testcase
-  :tags: Detailed Design & Code
+  :id: tool_req__docs_test_link_testcase
+  :tags: Testing
   :implemented: NO
+  :parent_covered: YES
   :satisfies: PROCESS_gd_req__req__attr_testlink
 
   Docs-as-Code shall allow requirements of type :need:`tool_req__docs_req_types` to
   include a ``testlink`` attribute.
 
   This attribute shall support linking test cases to requirements.
 
+
+.. tool_req:: Extract Metadata from Tests
+   :id: tool_req__docs_test_metadata_extraction
+   :tags: Testing
+   :implemented: NO
+   :parent_covered: NO
+   :satisfies: PROCESS_gd_req__verification__checks
+
+   Docs-as-Code shall be able to extract information from tests. 
+   Information to extract:
+
+   .. warning:: 
+      Not yet thought through what the best way for this is.
+      Tool req => incomplete
+
+
 🧪 Tool Verification Reports
 ############################
 
 .. they are so different, that they need their own section
 
+.. tool_req:: Tool Verification Report Mandatory Attributes
+   :id: tool_req__docs_tvr_attr_mandatory
+   :tags: Tool Verification Reports
+   :implemented: NO
+   :parent_covered: YES
+   :satisfies: PROCESS_gd_req__tool__check_mandatory
+   
+   Docs-as-Code shall enforce that the following attributes are set on `tool_verification_reports`
+
+   * Safety Affected
+   * Security Affected
+   * status
+   * UID
+
+
 .. tool_req:: Tool Verification Report
   :id: tool_req__docs_tvr_uid
   :tags: Tool Verification Reports
@@ -609,7 +727,7 @@ Architecture Attributes
   :satisfies: PROCESS_gd_req__tool_attr_security_affected
 
   Docs-as-Code shall enforce that every Tool Verification Report includes a
-  ``security_affected`` attribute with one of the following values:
+  `security_affected` attribute with one of the following values:
 
   * YES
   * NO
@@ -621,7 +739,7 @@ Architecture Attributes
   :satisfies: PROCESS_gd_req__tool__attr_status
   :parent_covered: YES
 
-  Docs-as-Code shall enforce that every Tool Verification Report includes a ``status``
+  Docs-as-Code shall enforce that every Tool Verification Report includes a `status`
   attribute with one of the following values:
 
   * draft
@@ -630,6 +748,11 @@ Architecture Attributes
   * released
   * rejected
 
+
+----------------
+Testing & Tests
+----------------
+
 ⚙️ Process / Other
 ###################
 
@@ -660,6 +783,8 @@ Architecture Attributes
   requirements.
 
 
+
+
 ..
 .. ------------------------------------------------------------------------
 ..

examples/linking-both/index.rst

@@ -42,7 +42,7 @@ This is a simple example of a documentation page using the `docs` tool.
    :id: tool_req__index__some_title
    :reqtype: Process
    :security: YES
-   :safety: ASIL_D
+   :safety: ASIL_B
    :satisfies: PROCESS_gd_req__req__attr_uid
    :status: invalid
 

examples/linking-both/testing/test.rst

@@ -33,7 +33,7 @@ This example will help catch things and bugs when rst's are defined inside a fol
    :id: tool_req__testing__some_title
    :reqtype: Process
    :security: YES
-   :safety: ASIL_D
+   :safety: ASIL_B
    :satisfies: PROCESS_gd_req__req__attr_uid
    :status: invalid