Skip to content

Commit 3f9664c

Browse files
committed
docs(traceability): align dashboards with coverage metrics
1 parent 810199a commit 3f9664c

2 files changed

Lines changed: 50 additions & 4 deletions

File tree

docs/internals/requirements/implementation_state.rst

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,23 @@ Implementation State Statistics
1919
Overview
2020
--------
2121

22+
.. note::
23+
**Implementation vs. Traceability:** A requirement can be "implemented" in code
24+
without having documentation links. This dashboard shows implementation status.
25+
26+
- **Not implemented**: ``implemented == 'NO'`` (actual TODO)
27+
- **Implemented but incomplete docs**: ``implemented == 'YES|PARTIAL'`` and missing source_code_link OR missing testlink
28+
- **Fully documented**: Both ``source_code_link`` and ``testlink`` present
29+
30+
The CI/CD gate check enforces minimum coverage thresholds for source_code_link and testlink.
31+
2232
.. needpie:: Requirements Status
23-
:labels: not implemented, implemented but not tested, implemented and tested
33+
:labels: not implemented, implemented (at least partial), fully documented
2434
:colors: red,yellow, green
2535

2636
type == 'tool_req' and implemented == 'NO'
27-
type == 'tool_req' and testlink == '' and (implemented == 'YES' or implemented == 'PARTIAL')
28-
type == 'tool_req' and testlink != '' and (implemented == 'YES' or implemented == 'PARTIAL')
37+
type == 'tool_req' and (implemented == 'YES' or implemented == 'PARTIAL') and (source_code_link == '' or testlink == '')
38+
type == 'tool_req' and (implemented == 'YES' or implemented == 'PARTIAL') and source_code_link != '' and testlink != ''
2939

3040
In Detail
3141
---------
@@ -45,13 +55,33 @@ In Detail
4555

4656
.. grid-item-card::
4757

48-
.. needpie:: Requirements with Codelinks
58+
.. needpie:: Requirements with Source Code Links
4959
:labels: no codelink, with codelink
5060
:colors: red, green
5161

5262
type == 'tool_req' and source_code_link == ''
5363
type == 'tool_req' and source_code_link != ''
5464

65+
.. grid-item-card::
66+
67+
.. needpie:: Requirements with Test Links
68+
:labels: no testlink, with testlink
69+
:colors: red, green
70+
71+
type == 'tool_req' and testlink == ''
72+
type == 'tool_req' and testlink != ''
73+
74+
.. grid-item-card::
75+
76+
.. needpie:: Full Traceability (Code + Test Links)
77+
:labels: fully linked, code only, test only, unlinked
78+
:colors: green, orange, yellow, red
79+
80+
type == 'tool_req' and source_code_link != '' and testlink != ''
81+
type == 'tool_req' and source_code_link != '' and testlink == ''
82+
type == 'tool_req' and source_code_link == '' and testlink != ''
83+
type == 'tool_req' and source_code_link == '' and testlink == ''
84+
5585
.. grid-item-card::
5686

5787
.. needpie:: Test Results

docs/internals/requirements/requirements.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -731,6 +731,22 @@ Architecture Attributes
731731
🔗 Code Linkage
732732
----------------
733733

734+
**Codelink Coverage Status**
735+
736+
.. needpie:: Tool Requirements with Source Code Links
737+
:labels: with codelink, without codelink
738+
:colors: green, red
739+
740+
type == 'tool_req' and source_code_link != ''
741+
type == 'tool_req' and source_code_link == ''
742+
743+
.. note::
744+
This dashboard is complemented by an automated CI check using
745+
``traceability_coverage``.
746+
The checker enforces minimum coverage thresholds. See
747+
:doc:`/how-to/test_to_doc_links` for detailed information on combining
748+
visual dashboards with CI/CD gates.
749+
734750
.. tool_req:: Supports linking to source code
735751
:tags: Detailed Design & Code
736752
:id: tool_req__docs_dd_link_source_code_link

0 commit comments

Comments
 (0)