Skip to main content

​
Overview

Analyze traceability coverage gaps grouped by business domain and technical layer. Identifies uncovered requirements and top priority gaps. Use to assess pipeline completeness. This tool provides a high-level overview of traceability coverage across your entire SDD pipeline, helping you identify which domains or layers need attention.

​
Parameters

​
domain
string
Filter by business domain (e.g. ‘Security & Auth’)
​
layer
string
Filter by technical layer: Infrastructure, Backend, Frontend, Integration/Deployment

​
Response

​
filters
object
Applied filters
​
domain
string | null
Domain filter if applied
​
layer
string | null
Layer filter if applied
​
totalReqs
number
Total number of requirements analyzed
​
overallCoverage
object
Overall traceability coverage statistics from graph
​
byDomain
array
Coverage breakdown by business domain
​
domain
string
Business domain name
​
total
number
Total requirements in this domain
​
covered
number
Requirements with complete coverage (UC + BDD + Code + Tests)
​
partial
number
Requirements with partial coverage
​
uncovered
number
Requirements with no coverage
​
coveragePercent
number
Percentage of fully covered requirements
​
byLayer
array
Coverage breakdown by technical layer
​
layer
string
Technical layer name
​
total
number
Total requirements in this layer
​
covered
number
Requirements with complete coverage
​
partial
number
Requirements with partial coverage
​
uncovered
number
Requirements with no coverage
​
coveragePercent
number
Percentage of fully covered requirements
​
uncovered
array
Up to 20 requirements with no coverage
​
id
string
Requirement ID
​
title
string
Requirement title
​
missingLinks
string[]
List of missing coverage types: UC, BDD, Code, Tests
​
topGaps
array
Up to 15 requirements closest to complete (sorted by fewest missing links)
​
id
string
Requirement ID
​
title
string
Requirement title
​
missingLinks
string[]
List of missing coverage types
​
codeIntelligence
object
Code intelligence coverage metrics (when available)
​
totalSymbols
number
Total code symbols analyzed
​
annotated
number
Symbols with explicit artifact references
​
inferred
number
Symbols with inferred artifact references
​
uncoveredSymbols
number
Symbols without any artifact references
​
annotatedPercentage
number
Percentage of explicitly annotated symbols
​
totalCoveredPercentage
number
Percentage of symbols with any coverage (annotated + inferred)

​
Coverage levels

  • Covered: Requirements with UC + BDD + Code + Tests
  • Partial: Requirements missing 1-3 coverage types
  • Uncovered: Requirements missing all 4 coverage types

​
Examples

​
Analyze overall coverage

{}

​
Check coverage for a specific domain

{
  "domain": "Security & Auth"
}

​
Analyze backend layer coverage

{
  "layer": "Backend"
}

​
Focus on specific domain and layer

{
  "domain": "User Management",
  "layer": "Frontend"
}

​
TypeScript types

interface CoverageArgs {
  domain?: string;
  layer?: string;
}

interface CoverageDetail {
  id: string;
  title: string;
  missingLinks: string[];
}

interface DomainCoverage {
  domain: string;
  total: number;
  covered: number;
  partial: number;
  uncovered: number;
  coveragePercent: number;
}

interface LayerCoverage {
  layer: string;
  total: number;
  covered: number;
  partial: number;
  uncovered: number;
  coveragePercent: number;
}

​
Understanding the results

​
Top gaps

The topGaps array contains requirements that are closest to complete, sorted by the number of missing links. These are your best candidates for quick wins:
  • Requirements with 1 missing link: Just need one more piece to be complete
  • Requirements with 2 missing links: Close to completion, good targets for sprint planning

​
Uncovered requirements

The uncovered array lists requirements with no coverage at all. These should be prioritized for:
  1. Creating use cases (UC)
  2. Writing BDD scenarios
  3. Implementing code
  4. Adding tests

​
Code intelligence metrics

When code intelligence is enabled, you get additional metrics about symbol-level coverage:
  • Annotated symbols: Have explicit @artifact annotations
  • Inferred symbols: Automatically linked based on naming patterns
  • Uncovered symbols: No artifact linkage at all

​
See also

Build docs developers (and LLMs) love

Get started for freeTalk to us