eclipse-score · masc2023 · Jul 15, 2025 · Jul 11, 2025
@@ -135,5 +135,6 @@ Project structure and processes
       modules/index
       contribute/index
       Releases <score_releases/index.rst>
+      Tools <score_tools/index.rst>
       PMP <platform_management_plan/index.rst>
       Eclipse <https://projects.eclipse.org/projects/automotive.score>
@@ -169,23 +169,4 @@ development, as they are not used:
 Tool List
 ^^^^^^^^^
 
-.. _platform_tool_list:
-
-.. list-table:: SW Platform tool overview
-    :header-rows: 1
-
-    * - tool Id
-      - tool name
-      - tool status
-      - tool TCL
-      - Link to tool evaluation issue (GitHub Issue)
-      - Link to tool qualification issue (GitHub Issue)
-      - Link to verification report (contains version, use cases, link to manuals, etc.)
-
-    * - #
-      - sphinx-needs
-      - draft <automated>
-      - not evaluated yet
-      - <Link to issue>
-      - <Link to issue>
-      - <Link to tool verification report>
+The S-CORE tools overview can be found here: :ref:`tools`
@@ -0,0 +1,181 @@
+..
+   # *******************************************************************************
+   # Copyright (c) 2025 Contributors to the Eclipse Foundation
+   #
+   # See the NOTICE file(s) distributed with this work for additional
+   # information regarding copyright ownership.
+   #
+   # This program and the accompanying materials are made available under the
+   # terms of the Apache License Version 2.0 which is available at
+   # https://www.apache.org/licenses/LICENSE-2.0
+   #
+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+.. document:: Doc-as-Code
+   :id: doc__tool__doc_as_code
+   :status: draft
+   :safety: ASIL_B
+   :security: YES
+   :tags: tool_management
+
+
+Doc-as-Code Verification Report
+===============================
+
+
+Identification
+--------------
+| UID                  Doc-as-Code
+| Version:             release-0.2.4
+| Status:              evaluated
+| Tcl:                 low
+| Safety_affected:     yes
+| Security_affected:   yes
+
+(todo: discuss to update metamodel with the attributes above, what can be automated?)
+
+
+Introduction
+------------
+
+Scope and purpose
+~~~~~~~~~~~~~~~~~
+Generate documentation (.html files) based on text files (.rst / .md) and configuration data.
+
+
+Inputs and outputs
+~~~~~~~~~~~~~~~~~~
+
+Inputs are restructured text files (.rst) and markdown files (,md)
+Outputs are HTML files (.html)
+
+.. figure:: _assets/doc_as_code.drawio.svg
+  :width: 100%
+  :align: center
+  :alt: Doc-as-Code overview
+
+  Doc-as-Code overview
+
+Available information
+~~~~~~~~~~~~~~~~~~~~~
+
+Project Documentation is available here:
+
+`Doc-as-Code Project Documentation <https://eclipse-score.github.io/docs-as-code/main/index.html>`_
+
+This includes getting started or usage information and integration manual.
+
+The capabilities of the tool can be found here:
+
+`Doc-as-Code Project Capabilities <https://eclipse-score.github.io/docs-as-code/main/product/capabilities.html#capabilities>`_
+
+
+Installation and integration
+----------------------------
+
+Tool location:
+
+`Release 0.4.2 <https://github.com/eclipse-score/docs-as-code/tree/v0.4.2>`_
+
+How to integrate:
+
+`Doc-as-Code Integration <https://eclipse-score.github.io/docs-as-code/main/how-to-integrate/index.html>`_
+
+Environment: github, python, Version 3.y.z, sphinx, Version x.y.z, sphinx-needs, Version x.y.z
+Supported platforms: Windows, Linux
+
+
+Evaluation
+----------
+
+.. list-table:: S-CORE software modules overview
+   :header-rows: 1
+
+   * - Use case Identification
+     - Use case Description
+     - Malfunctions
+     - Impact on safety?
+     - Impact safety measures available?
+     - Impact safety detection sufficient?
+     - Threats
+     - Impact on security?
+     - Impact security measures available?
+     - Impact security detection sufficient?
+     - Further additional safety measure required?
+     - Confidence (automatic calculation)
+   * - 1
+     - Generate element (requirements, architecture, safety analysis, ...)
+     - Wrong or missed element may lead to an wrong implementation with any potential error
+     - yes
+     - Reviews
+     - no
+     - Gain access to modify or run manipulated Doc-as-code or to to modify input files
+     - yes
+     - Access control, roles in Github
+     - yes
+     - Compare generated text in documentation with original text (#PR)
+     - low
+   * - 2
+     - Link elements
+     - Wrong or missed links may lead to wrong elements and finally to wrong implementation with any potential error
+     - yes
+     - Reviews, Link rules checker
+     - no
+     - Gain access to modify or run manipulated Doc-as-code or to to modify input files
+     - yes
+     - Access control, roles in Github
+     - yes
+     - Compare generated links in documentation with original links (#PR)
+     - low
+   * - 3
+     - Generate statistics
+     - Wrong or missing statistics may lead to wrong compliance statements, KPI reports, decisions
+     - yes
+     - Spot checks
+     - no
+     - Gain access to modify or run manipulated Doc-as-code or to to modify input files
+     - yes
+     - Access control, roles in Github
+     - yes
+     - Add diverse statistic generator tool (#PR)
+     - low
+   * - 4
+     - Check documentation rules based on configuration
+     - Checks are not properly implemented, so may lead to wrong elements/links
+     - yes
+     - Code reviews, test for rules
+     - yes
+     - Gain access to modify or run manipulated Doc-as-code or to to modify input files
+     - yes
+     - Access control, roles in Github
+     - yes
+     - n/a
+     - high
+
+
+Result
+~~~~~~
+Tool Qualification Required
+
+
+Tool Qualification
+------------------
+Based on method: validation of the software tool
+
+
+Requirements and testing aspects
+--------------------------------
+Tool requirements are defined here:
+
+`Doc-as-Code Requirements <https://eclipse-score.github.io/docs-as-code/main/product/requirements.html#requirements>`_
+
+Test cases and tests are defined here:
+
+`Doc-as-Code Test cases and tests <https://github.com/eclipse-score/docs-as-code/tree/v0.4.2/src/extensions>`_
+
+The tests are part of the rules checker code sections.
+
+Requirements coverage is documented here:
+
+`Doc-as-Code Requirements <https://eclipse-score.github.io/docs-as-code/main/product/requirements.html#requirements>`_
@@ -0,0 +1,32 @@
+..
+   # *******************************************************************************
+   # Copyright (c) 2024 Contributors to the Eclipse Foundation
+   #
+   # See the NOTICE file(s) distributed with this work for additional
+   # information regarding copyright ownership.
+   #
+   # This program and the accompanying materials are made available under the
+   # terms of the Apache License Version 2.0 which is available at
+   # https://www.apache.org/licenses/LICENSE-2.0
+   #
+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+.. _tools:
+
+S-CORE Tools Overview
+=====================
+
+.. needtable:: Tools List
+   :tags: tool_management
+   :filter: "tool_management" in tags and type == "document" and is_external == False
+   :style: table
+   :sort: status
+   :columns: id as "UID";title as "TITLE";status as "STATUS";safety as "SAFETY"
+   :colwidths: 30,30,30,30
+
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+
+   doc_as_code