Docs Review

SkillDocs & knowledge

Review documentation for quality, clarity, SEO, and technical correctness. Optimized for Docus/Nuxt Content but works with any Markdown documentation. Use when asked to: "review docs", "check documentation", "audit docs", "validate documentation", "improve docs quality", "analyze documentation", "ch

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the Docs Review skill

What this skill tells your AI

The instructions your AI receives, as published by atoms-studio/nuxt-swiftsearch in .agents/skills/review-docs/SKILL.md and read by ahel’s review.

Does this make sense?


Read Like An AI

Agents don't ask questions. They read and act.

Question: Can an AI understand this without human help?


What To Check

1. Clear Purpose

# What's this about?
## This does X
CheckIssue
No headerCan't find topic
Vague headerCan't understand
No summaryCan't trust

2. Codeblocks

Every codeblock needs:

// What it does
const x = doThing()
CheckIssue
No explanationCan't use
Wrong languageCan't run
OutdatedWon't work

3. Examples

# Example
```bash
npm install vant
CheckIssue
No examplesCan't try
Wrong commandWon't work
PartialConfusing

4. Structure

## Step 1
## Step 2
## Step 3
CheckIssue
No stepsCan't follow
Wrong orderConfusing
Missing stepsStuck

AI-First Test

Try explaining to another AI:

"Read this doc and do the thing. Tell me what you'd need to know."

If they can't do it, fix the doc.


Output

## Docs Review - [file]

### Purpose
- [CLEAR/VAGUE] Header: [text]

### Codeblocks
- [OK/MISSING] [count] codeblocks explained

### Examples
- [OK/MISSING] Examples work

### Structure
- [OK/ROUGH] Walkthrough complete

Role: Docs Reviewer Input: Documentation Output: AI-readable?

Signals

GitHub stars
66
Forks
12
Last commit
May 2026
Advanced
Catalog kind
skill
Gateway key
review-docs
Source
github.com/atoms-studio/nuxt-swiftsearch