docs-validator

Assess Logs;eq Graph Template module and guide documentation quality with structured checks and actionable feedback.

8|1|Updated Mar 30, 2025
One-click install
npx skills add https://github.com/C0ntr0lledCha0s/logseq-template-graph --skill docs-validator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-validator
Source: https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/docs-validator
Command: npx skills add https://github.com/C0ntr0lledCha0s/logseq-template-graph --skill docs-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining high-quality, accurate, and consistent documentation across a growing project is a constant challenge. This skill automates the validation process, identifying issues like broken links, outdated information, and formatting errors, saving you time and ensuring user trust.

Core Features & Use Cases

  • Comprehensive Audit: Checks documentation for completeness, accuracy, formatting, internal/external links, and consistency.
  • Issue Reporting: Provides detailed reports with specific locations of errors and actionable recommendations for fixes.
  • Use Case: Before a new release, run a full documentation audit to catch any broken links or outdated information, ensuring users have a seamless experience.

Quick Start

Run a full documentation audit on all project documentation files and provide a report of any issues found.

Frequently Asked Questions about docs-validator

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

FAQPage Schema
How do I validate documentation for broken links and outdated content?

Documentation validation checks for broken links, outdated information, and formatting errors across your files. Run a full audit on your project documentation to identify issues with specific locations and receive actionable remediation suggestions before release.

What does a documentation quality audit check?

A documentation audit assesses completeness, accuracy, formatting consistency, and internal/external link validity. It generates detailed reports highlighting specific errors and concrete fixes to ensure your docs meet quality standards.

Can I validate markdown documentation for consistency and formatting issues?

Yes. The validation process checks markdown files for formatting errors, consistency issues, and structural problems across your documentation. It provides detailed feedback on what needs fixing and how to fix it.

When should I run a documentation audit?

Run a full documentation audit before releasing a new version to catch broken links, outdated references, and formatting inconsistencies. This ensures users encounter accurate, functional documentation without gaps or errors.

How do I identify incomplete or inaccurate technical documentation?

Documentation validation performs completeness and accuracy checks against structured checklists and version-aware references. It flags gaps, outdated sections, and inconsistencies, then outputs validation-ready reports with concrete remediation steps.

Does documentation validation work with module guides and technical documentation?

Yes. The validation applies to module documentation, user guides, and technical docs for projects like Logseq Template Graph. It checks all documentation types using the same comprehensive completeness, accuracy, and link validation checks.