traceability-check

Maps requirements to code and tests, computes coverage gaps and generates a traceability report.

175|26|Updated Aug 14, 2025
One-click install
npx skills add https://github.com/jmagly/ai-writing-guide --skill traceability-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: traceability-check
Source: https://github.com/jmagly/ai-writing-guide/tree/main/.factory/skills/traceability-check
Command: npx skills add https://github.com/jmagly/ai-writing-guide --skill traceability-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires artifact-metadata, project-awareness, and includes references (resource) components.

What problem does it solve?

This Skill eliminates coverage gaps by automatically verifying bidirectional traceability from requirements to code to tests.

Core Features & Use Cases

  • Bidirectional Traceability: Automatically maps requirements to implementation and test coverage.
  • Gap Analysis: Identifies orphan requirements, untested code, and rogue features without requirement links.

Quick Start

When you say "check traceability", this Skill scans your requirements, code, and tests to build a complete traceability matrix and identify coverage gaps.

Example Output

"Traceability Analysis Complete

Requirements: 65 Implemented: 60 (92%) Tested: 51 (78%)

Gaps Found:

  • 5 orphan requirements (no code)
  • 9 untested requirements
  • 3 code files with no requirement links

Report: .aiwg/reports/traceability-20251208.md"

Frequently Asked Questions about traceability-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I verify requirements traceability from code to tests?

Requirements traceability automatically maps your documented requirements (UC-*, REQ-*, NFR-*) to implementation code and test coverage, then identifies gaps. It scans requirement files, code comments and annotations, and tests to build a bidirectional matrix showing which requirements are implemented and tested.

Can I detect orphan requirements and untested code in my project?

Yes. The traceability check identifies orphan requirements with no code implementation, untested requirements lacking test coverage, and code files with no requirement links. It generates a gap report showing coverage percentages and specific artifacts missing bidirectional links.

What requirement ID formats does traceability coverage analysis support?

Traceability coverage analysis recognizes UC-*, REQ-*, and NFR-* requirement ID formats stored in .aiwg/requirements. It scans code for these IDs in comments, annotations, and commit messages, then matches them against test coverage to compute bidirectional traceability.

Do I need existing documented requirements to run traceability analysis?

Yes. Traceability analysis requires a software project with documented requirements in standardized formats (UC-*, REQ-*, NFR-*) plus corresponding code and test artifacts. Without requirement documentation, the tool cannot establish the bidirectional mapping needed for gap detection.

What does a traceability coverage report include?

The report shows total requirements counted, implementation percentage, test coverage percentage, and specific gaps: orphan requirements lacking code, untested requirements, and code files without requirement links. Output is a markdown report with statistics and actionable recommendations.

How does traceability analysis prevent scope creep and missing coverage?

By identifying rogue code features with no linked requirements and requirements with no implementation or tests, traceability analysis prevents untracked scope additions and ensures complete coverage. Gap reports highlight which artifacts break bidirectional traceability, enabling teams to close coverage systematically.