doc-traceability-validator

Validate traceability between @implements code annotations and documentation registries.

2.1k|244|Updated Dec 21, 2025
One-click install
npx skills add https://github.com/raphaelmansuy/edgequake --skill doc-traceability-validator-raphaelmansuy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-traceability-validator
Source: https://github.com/raphaelmansuy/edgequake/tree/main/.github/skills/doc-traceability-validator
Command: npx skills add https://github.com/raphaelmansuy/edgequake --skill doc-traceability-validator-raphaelmansuy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Codebases using @implements FEATXXXX annotations drift out of sync with documentation registries, causing ID collisions, undocumented features, and broken cross-references between features, business rules, and use cases. ## Core Features & Use Cases - Feature Validation: Scan TypeScript and Rust code for @implements annotations and compare against features.md to find undocumented or orphaned features. - Traceability Chain Validation: Verify that FEAT, BR, and UC cross-references resolve correctly across features.md, business_rules.md, and use_cases.md. - Registry Generation: Auto-generate features.md entries from code annotations, and enforce namespace range allocation per team and module. - Use Case: Add the validation script to a CI/CD pipeline with a fail threshold so pull requests introducing duplicate FEAT IDs or documentation gaps are blocked automatically. ## Quick Start Ask the AI to run the validate_features.py script against your source directory and features.md file to report undocumented features and duplicate IDs.

Frequently Asked Questions about doc-traceability-validator

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

FAQPage Schema
How do I validate @implements annotations against a features registry?

Run validate_features.py with --code-dir pointing at your source tree and --docs-file pointing at features.md. It reports undocumented features, orphaned entries, and duplicate IDs with completeness and uniqueness scores.

How do I check cross-references between features, business rules, and use cases?

Use validate_traceability.py with the --features, --rules, and --usecases arguments. It extracts FEAT, BR, and UC references from each document and reports broken links plus cross-reference coverage percentages.

Does this validation require external Python dependencies?

No external dependencies are required. All scripts use only the Python 3.9+ standard library, including re, pathlib, argparse, json, and dataclasses, so they run in any CI environment without pip installs.

Can I block pull requests when documentation validation fails?

Yes, use the --fail-threshold flag on validate_features.py or --fail-on-broken on validate_traceability.py. The scripts exit with code 1 when scores fall below the threshold or broken references exist, failing the CI job.

Why are duplicate FEAT IDs sometimes reported as acceptable?

The validator distinguishes cross-cutting duplicates from true collisions. The same feature ID spanning multiple architectural layers like types, stores, hooks, and components is intentional in React/TypeScript codebases, while same-layer duplicates are flagged as collisions.

How do I generate features.md entries from code annotations?

Run generate_registry.py with --code-dir and --output. It scans for @implements annotations, infers descriptions from doc comments, groups entries by module namespace, and writes markdown entries plus an index table.