review-docs

Name: review-docs
Availability: InStock
Author: woody1234567

Analyze Markdown documentation quality and generate a prioritized review report.

1|1|Updated Mar 14, 2026

Search Tags:#documentation #clarity #structure #review #i18n #seo #nuxt-content

Ready to run

npx skills add https://github.com/woody1234567/docus_teaching --skill review-docs-woody1234567

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/woody1234567/docus_teaching/tree/main/.agents/skills/review-docs
Command: npx skills add https://github.com/woody1234567/docus_teaching --skill review-docs-woody1234567

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Review and improve documentation quality, structure, and search visibility across projects that use Docus/Nuxt Content or generic Markdown.

Core Features & Use Cases

Detect project type (Docus/Nuxt Content vs generic Markdown) and apply appropriate validations.
Analyze clarity, SEO, structure, and i18n (if applicable) with actionable recommendations.
Generate a comprehensive report with a recommended action plan and optional fix workflow; example: auditing a Nuxt Content docs site to improve search visibility.

Quick Start

Provide a complete documentation audit and generate a detailed report with prioritized issues.

Frequently Asked Questions about review-docs

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

FAQPage Schema

How do I review documentation quality and SEO for a Nuxt Content project?▼

To review documentation quality and SEO for a Nuxt Content project, the system analyzes frontmatter, MDC usage, clarity, and structure to generate a prioritized, actionable report. This process detects project type automatically and enforces frontmatter requirements to improve documentation search visibility.

What is the best way to audit generic Markdown docs for structure and clarity?▼

The best way to audit generic Markdown docs for structure and clarity is to run a comprehensive review that validates navigation, analyzes frontmatter requirements, and checks section structure. This generates a detailed report with a recommended action plan and optional fix workflow for improving overall documentation quality.

Can I check internationalization and frontmatter requirements in Docus documentation?▼

Yes, you can check internationalization and frontmatter requirements in Docus documentation. The review validates proper MDC prefixes, enforces frontmatter rules, and analyzes i18n where present to ensure structural compliance and generate a structured quality report.

How do I generate a prioritized action plan for fixing documentation issues?▼

You generate a prioritized action plan for fixing documentation issues by analyzing your docs for clarity, SEO, structure, and i18n problems. The resulting structured review report outputs a recommended action plan and an optional fix workflow to address identified vulnerabilities systematically.

Does the documentation review work with both Docus and generic Markdown files?▼

Yes, the documentation review works with both Docus and generic Markdown files. It automatically detects the project type to apply appropriate validations, analyzing MDC usage for Docus while validating navigation and section structure across generic Markdown documentation.

Why does my Nuxt Content documentation need frontmatter and MDC prefix validation?▼

Your Nuxt Content documentation needs frontmatter and MDC prefix validation to enforce structural compliance and ensure proper rendering. Validating these elements prevents navigation issues, improves search visibility, and maintains documentation quality standards across the project.