Does it check for broken links?

Yes, it includes a link validation engine that verifies internal file references, header anchors, and optionally external URLs.

How are validation issues reported?

Issues are returned in a structured JSON format that identifies the specific file, line number, severity level, and a descriptive error message.

What is strict mode in the doc-validator?

Strict mode treats all warnings as errors, causing the validation status to fail if any inconsistencies are found, which is ideal for pre-commit hooks.

What document types can this skill validate?

The skill includes built-in support for ADRs, design documents, runbooks, API specifications, test reports, and deployment guides.

Can I validate an entire directory at once?

Yes, the skill supports a 'validate-directory' operation that recursively scans and checks all markdown files within a specified path.

Documentation Validator

Name: Documentation Validator
Author: fractary

$fractary$ byfractary

•

Content Management

Ensures high-quality technical documentation by validating markdown files against type-specific schemas, structures, and linting rules.

The Documentation Validator is a powerful skill designed to maintain rigorous standards across your project's knowledge base. It dynamically applies validation rules tailored to specific document types—such as Architecture Decision Records (ADRs), Design Docs, Runbooks, and API Specs—to ensure consistency and completeness. By automating checks for YAML frontmatter accuracy, required section hierarchies, markdown syntax, and link integrity, this tool helps development teams eliminate broken documentation and maintain professional, searchable, and compliant project records without manual proofreading.

Key Features

012 GitHub stars

02Comprehensive link validation for internal relative paths and external URLs

03Dynamic schema validation for specialized document types like ADRs and API specs

04Structured JSON error reporting with severity levels (Error, Warning, Info)

05Deep structure analysis to ensure required headings and sections are present

06Automated YAML frontmatter verification for required fields and data types

Use Cases

01Standardizing API specifications and runbooks for better developer experience and onboarding

02Enforcing standardized Architecture Decision Record (ADR) formats across large engineering teams

03Automating documentation quality gates in CI/CD pipelines to prevent broken links and missing sections

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add fractary/claude-plugins doc-validator

For use in Claude.ai and ChatGPT

Download Skill