check-docs

Audit documentation health by verifying source mappings, links, and terminology consistency.

60|2|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/reasondb/reasondb --skill check-docs-reasondb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-docs
Source: https://github.com/reasondb/reasondb/tree/main/docs/.claude/skills/check-docs
Command: npx skills add https://github.com/reasondb/reasondb --skill check-docs-reasondb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams maintain accurate documentation by performing automated health checks that compare docs against their sources, flagging inconsistencies, broken links, and missing references.

Core Features & Use Cases

  • Source verification: validates that each doc page has a corresponding source file and signatures match.
  • Link and structure validation: ensures internal links are resolvable, pages exist, and navigation is consistent.
  • Terminology and consistency: checks usage of glossary terms and branding according to context.
  • Use Case: A technical writer runs the skill to identify documentation pages that are out of sync with source code, and to mark them for review.

Quick Start

Run the check-docs skill against your docs directory to audit internal links, verify source mappings, and flag unverified pages.

Frequently Asked Questions about check-docs

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

FAQPage Schema
How do I verify documentation consistency against source code?

Verifying documentation consistency involves auditing docs against source files to check mappings, validate signatures, and flag missing references. This automated health check reads context.json, infers docType, and provides remediation guidance for out-of-sync pages.

What is the best way to find broken links and missing pages in a large docs repository?

Finding broken links and missing pages requires running structure validation to ensure internal links resolve and navigation remains consistent. This automated audit checks page existence and flags unresolvable references across large documentation repositories.

How do I check terminology consistency across multiple documentation pages?

Checking terminology consistency across documentation pages requires an automated audit that validates glossary terms and branding according to context. It enforces context-aware validation steps by reading context.json and applying standardized checks across pages.

Can I validate code blocks and source mappings without configuring dependencies?

Validating code blocks and source mappings requires no external dependencies. The audit operates directly on your docs directory, reading context.json if present, inferring docType, and performing standardized checks with zero setup required.

Why does my documentation audit flag unverified pages after a source code update?

Documentation audits flag unverified pages after source code updates because the docs no longer align with their corresponding sources. The audit detects missing source files, signature mismatches, and broken links, marking affected pages for review.