skills.rest
vertexcover-io
vertexcover-ioOFFICIAL
Explore all skills by this author →
WebsiteGitHub

doc-quality-guard

Audit repository documentation for code accuracy and tone, then generate a fix spec.

4|Updated Jan 1, 2026
Search Tags:#documentation#tone#audit#quality#docs#orchestrate#fix-spec
One-click install
npx skills add https://github.com/vertexcover-io/tarash --skill doc-quality-guard
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-quality-guard
Source: https://github.com/vertexcover-io/tarash/tree/main/.claude/skills/doc-quality-guard
Command: npx skills add https://github.com/vertexcover-io/tarash --skill doc-quality-guard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audits documentation for accuracy (code-doc sync, staleness) and tone (AI slop), then generates a fix spec and hands off to /orchestrate.

Core Features & Use Cases

  • Scans repository docs including docs/, READMEs, and API reference pages to detect API signature drift, outdated examples, broken links, and deprecated install instructions.
  • Executes a multi-agent workflow that cross-checks documentation against source code, highlighting discrepancies and generating a fixes spec.
  • Maintains a consistent, concise tone by flagging AI slop patterns and aligning with tone references.

Quick Start

Announce that doc-quality-guard is auditing the documentation and run the audit workflow.

Frequently Asked Questions about doc-quality-guard

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

FAQPage Schema
How do I audit documentation for code-doc sync and outdated examples?▼

Audit documentation for code-doc sync by running a multi-agent workflow that cross-checks repository docs against source code to detect API signature drift, outdated examples, and broken links.

What is AI slop in documentation and how do I detect it?▼

AI slop in documentation refers to inconsistent or verbose AI-generated tone patterns. Detect it by auditing docs against tone references to flag these patterns and align the content.

How do I fix broken links and deprecated install instructions in my README and API reference pages?▼

Fix broken links and deprecated install instructions in READMEs and API reference pages by running an audit that generates a structured fix spec and triggers orchestration for automated updates.

Can I automatically generate a fix spec for wrong API signatures in my docs?▼

Yes, automatically generate a structured fix spec for wrong API signatures by scanning repository docs to catch discrepancies and outputting a spec to the dev-docs/superpowers/specs directory.

Does documentation auditing work for repo-wide docs including docs/ folders?▼

Yes, documentation auditing works for repo-wide docs including docs/ folders, READMEs, and API reference pages to catch wrong API signatures, outdated examples, and broken links.

What is the best way to orchestrate documentation fixes after an audit?▼

The best way to orchestrate documentation fixes after an audit is to generate a structured fix spec and hand off to an orchestration system that processes the concise, audit-focused report.

Related Skills

Explore More Content & Communication Skills→
troykellytroykelly
11

documentation-audit

Audit documentation drift across Swagger/OpenAPI, features docs, and codebase.

Community
Advanced
miles990miles990
19

consistency-checker

Detect and fix content inconsistencies across code, documentation, and repositories.

Community
Advanced
open-circleopen-circle
1.1k

repo-website-api-review

Review API documentation routes against source code for accuracy.

Official
Intermediate
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced