skills.rest
brainfish-ai
brainfish-aiOFFICIAL
Explore all skills by this author →
WebsiteGitHub

check-docs

Audit documentation health by verifying content against source files and project context.

Updated Jan 23, 2026
Search Tags:#documentation#docs#quality-assurance#terminology#health-check#link-validation#source-verification
One-click install
npx skills add https://github.com/brainfish-ai/devdoc --skill check-docs-brainfish-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-docs
Source: https://github.com/brainfish-ai/devdoc/tree/main/public-apis/meta/.claude/skills/check-docs
Command: npx skills add https://github.com/brainfish-ai/devdoc --skill check-docs-brainfish-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill performs rapid health checks of documentation by cross-referencing content with source files and project context to identify gaps, inconsistencies, and outdated references.

Core Features & Use Cases

  • Source verification: checks for documentation pages with missing or unverifiable source files.
  • Term and link validation: ensures terminology usage aligns with glossary and all internal links resolve.
  • Remediation guidance: provides actionable fixes and next steps to restore doc integrity.

Quick Start

Run the health check across your docs to surface unverified pages and recommended fixes.

Frequently Asked Questions about check-docs

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

FAQPage Schema
How do I verify that my API documentation matches the source files?▼

Run a documentation health check to cross-reference API docs against source files and project context. This process identifies missing source files and provides actionable remediation guidance to fix inconsistencies.

What is the best way to check for broken links and invalid terminology in user guides?▼

Check for broken links and invalid terminology in user guides by running a documentation health check. It validates internal link resolution and ensures terminology usage aligns with your project glossary to maintain content consistency.

Can I use this documentation health check on both code docs and user guides?▼

Yes, you can use this documentation health check on code docs, API references, and user guides. It audits content by verifying source presence and terminology usage across various documentation types to ensure overall integrity.

How do I find documentation pages with missing source files?▼

Find documentation pages with missing source files by running a rapid health check. It performs source verification to surface pages that lack verifiable source files or project context, providing structured outputs and recommended fixes.

What does a documentation remediation guidance report include?▼

A documentation remediation guidance report includes actionable fixes and next steps to restore doc integrity. It provides structured outputs detailing unverified pages, invalid terminology, and broken links identified during the health check.

Related Skills

Explore More Content & Communication Skills→
silaslopes100silaslopes100

reversa-docs-storyteller

Generate interactive glossaries, slide decks, and feature HTML pages from project specifications.

Community
Advanced
reasondbreasondb
60

check-docs

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

Official
Intermediate
tim099tim099
4

ucl-translate-docs

Translate Markdown files with glossary checks and link preservation.

Community
Advanced
lehuuhau1231lehuuhau1231

lint-and-validate

Run linting and type checking across multiple programming ecosystems.

Community
Intermediate