documentation-quality-assurance

Audit documentation for accuracy, integrity, and currency.

1|1|Updated Nov 20, 2025
One-click install
npx skills add https://github.com/fabioc-aloha/AIRS_Data_Analysis --skill documentation-quality-assurance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-quality-assurance
Source: https://github.com/fabioc-aloha/AIRS_Data_Analysis/tree/main/.github/skills/documentation-quality-assurance
Command: npx skills add https://github.com/fabioc-aloha/AIRS_Data_Analysis --skill documentation-quality-assurance

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill prevents documentation from becoming outdated, inaccurate, or broken, ensuring that users and systems always have access to reliable information.

Core Features & Use Cases

  • Drift Detection: Identifies discrepancies between documentation and the actual codebase or system state.
  • Preflight Validation: Runs automated checks on documentation before changes are merged.
  • Multi-Pass Quality Pipeline: Enforces a rigorous, multi-stage review process for all documentation.
  • Use Case: Before releasing a new version of your software, this Skill can automatically scan all updated documentation for broken links, outdated feature descriptions, and semantic inaccuracies, preventing the release of misleading information.

Quick Start

Run a full documentation audit using the documentation-quality-assurance skill.

Frequently Asked Questions about documentation-quality-assurance

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

FAQPage Schema
How do I detect documentation drift between my codebase and markdown files?

Run a full documentation audit to detect drift by comparing documentation claims against the actual codebase state, identifying discrepancies like phantom features, stale claims, and count drift automatically.

What is preflight validation for documentation and when do I need it?

Preflight validation runs automated checks on documentation before changes are merged, ensuring link integrity and semantic accuracy. You need it before releasing new software versions to prevent publishing misleading information.

How do I scan updated documentation for broken cross-references and outdated features?

Use a multi-pass quality pipeline to scan updated documentation for broken cross-references, outdated feature descriptions, and semantic inaccuracies, enforcing a rigorous multi-stage review process before release.

Can I run an automated documentation audit without external dependencies?

Yes, you can run a full documentation audit without external dependencies. The validation pipeline operates independently to verify link integrity, check semantic accuracy, and detect count drift in your docs.

What is the best way to maintain documentation accuracy across multiple software releases?

The best way to maintain documentation accuracy is implementing a multi-pass quality pipeline that performs drift detection, preflight validation, and link integrity verification before every release merge.