validate-generated-docs

Validate generated documentation for scope, evidence, links, and structure.

Updated Feb 10, 2026
One-click install
npx skills add https://github.com/jrodrigopuca/skills --skill validate-generated-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: validate-generated-docs
Source: https://github.com/jrodrigopuca/skills/tree/main/create-software-docs/sub-skills/validate-generated-docs
Command: npx skills add https://github.com/jrodrigopuca/skills --skill validate-generated-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the critical need to verify the accuracy, completeness, and adherence to standards of automatically generated documentation before it's finalized.

Core Features & Use Cases

  • Scope Validation: Confirms that generated files reside within the expected directory structure.
  • Link Integrity: Checks for broken internal and cross-document links.
  • Evidence & Consistency: Verifies the presence of evidence markers and overall document coherence.
  • Use Case: After an AI generates documentation for a new software module, this Skill acts as a quality gate, flagging any missing citations, broken links, or sections that deviate from the defined scope, ensuring a high standard of output.

Quick Start

Validate the generated documentation in the 'api-docs' scope with a standard level of review.

Frequently Asked Questions about validate-generated-docs

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

FAQPage Schema
How do I validate generated documentation for scope correctness and broken links?

To validate generated documentation, you check files for scope correctness, evidence markings, link integrity, and structural completeness across specified scopes using defined validation levels like minimal, standard, or full.

What is documentation validation in automated pipelines?

Documentation validation in automated pipelines acts as a quality gate to verify the accuracy, completeness, and standards adherence of generated files before finalization, flagging missing citations or broken internal links.

How do I check code documentation for evidence markers and document consistency?

You check code documentation for evidence markers and document consistency by applying structured validation levels to the generated files, ensuring overall coherence and verifying that all required citations are present.

Does documentation validation work with automated editorial review workflows?

Documentation validation works with automated editorial review workflows by applying scope validation and structural completeness checks, outputting structured findings for any sections that deviate from defined standards.

What is the best way to ensure generated files reside within the expected directory structure?

The best way to ensure generated files reside within the expected directory structure is to perform scope validation, which confirms that all output files match the predefined directory paths and structural requirements.