doc-validator

Validate cross-document traceability and integrity across SDD framework documents.

16|3|Updated Nov 10, 2025
One-click install
npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-validator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-validator
Source: https://github.com/vladm3105/aidoc-flow-framework/tree/main/.claude/skills/doc-validator
Command: npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill doc-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires tiktoken.

What problem does it solve?

This Skill enforces documentation quality standards across all SDD artifacts, ensuring consistency, traceability, and compliance with project requirements, preventing common errors before documents are committed.

Core Features & Use Cases

  • Token Count & Language Validation: Automatically check document size against AI tool limits and enforce objective, factual language standards, flagging subjective claims.
  • Cross-Reference & ID Format Validation: Verify all internal links, external file references, and ensure document IDs follow strict naming conventions (e.g., REQ-AUTH-001).
  • Traceability Matrix Validation: Ensure all requirements have source references and validate forward/backward traceability chains (e.g., REQ → BDD → TASK).
  • Use Case: Before committing a new requirements document, use this skill to automatically check if it exceeds token limits for AI tools, contains subjective language, has broken cross-references, or if its IDs are malformed, providing immediate feedback and fix suggestions.

Quick Start

Use the doc-validator skill to validate the documentation file 'reqs/requirements.md'.

Frequently Asked Questions about doc-validator

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

FAQPage Schema
How do I validate documentation cross-references and traceability across multiple SDD framework documents?

Documentation traceability validation checks internal links, ID formats, and forward/backward consistency chains across BRD, PRD, EARS, BDD, ADR, SYS, REQ, IMPL, CTR, SPEC, TASKS, and IPLAN documents. Use doc-validator to detect broken cross-references, orphaned artifacts, and bidirectional traceability gaps automatically before committing.

Can I check if my requirements documents exceed token limits for AI tools?

Yes, doc-validator performs token count validation against AI tool limits using tiktoken, flagging documents that exceed thresholds. It simultaneously enforces objective, factual language standards and identifies subjective claims that could affect downstream AI processing.

What does documentation traceability matrix validation actually check?

Traceability matrix validation ensures all requirements have source references and validates complete forward/backward chains (e.g., REQ → BDD → TASK). It enforces bidirectional consistency, detects duplicate IDs, and identifies orphaned requirements without proper connection points.

How do I verify that document IDs follow naming conventions across my project?

Doc-validator applies strict ID format validation across all documents, enforcing conventions like REQ-AUTH-001. Graph traversal and cross-reference validation detect malformed IDs and broken links, providing fix suggestions for immediate remediation.

Can I use this to validate external file references in documentation?

Yes, doc-validator verifies both internal links and external file references as part of its cross-reference validation. It flags broken or incorrect file paths and ensures all references conform to project-wide ID and naming standards.

What happens if my documentation has orphaned artifacts or traceability gaps?

Doc-validator detects orphaned artifacts—requirements without proper source or downstream traceability—and identifies gaps in cross-document chains. It reports these violations with specific artifact IDs and layer information, enabling targeted remediation before document commit.