Back to Skills

vibe-docs

verified

Validate documentation claims against deployment reality. Use when checking if docs accurately describe what's deployed, finding false claims, or auditing doc accuracy. Triggers: "verify docs", "doc audit", "check doc claims", "docs match reality", "validate doc status".

View on GitHub

Marketplace

agentops-marketplace

boshu2/agentops

Plugin

general-kit

productivity

Repository

boshu2/agentops
6stars

plugins/general-kit/skills/vibe-docs/SKILL.md

Last Verified

January 24, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/boshu2/agentops/blob/main/plugins/general-kit/skills/vibe-docs/SKILL.md -a claude-code --skill vibe-docs

Installation paths:

Claude
.claude/skills/vibe-docs/
Powered by add-skill CLI

Instructions

# Vibe-Docs Skill

Semantic validation for documentation - verifies claims match deployment reality.

## Overview

**Structure vs Semantic:**
- `/doc` validates STRUCTURE (links, coverage, sections)
- `/vibe-docs` validates TRUTH (do claims match reality?)

**When to Use:**
- After deployment changes
- Before releases
- When docs feel "stale"
- Periodic audits (monthly)

---

## Commands

| Command | Action |
|---------|--------|
| `status` | Check status claims against deployment |
| `agents` | Verify agent catalog matches cluster |
| `images` | Verify IMAGE-LIST matches registry |
| `full` | Run all checks |

---

## Phase 1: Gather Claims

Extract claims from documentation:

```bash
# Status claims
grep -r "Current Status:" docs/code-map/ | grep -E "RUNNING|FAILED|DEPLOYED"

# Agent claims
grep -E "✅ Deployed|✅ Ready|DEPLOYED" docs/

# Image claims
grep -E "image:|Image:" charts/*/IMAGE-LIST.md
```

---

## Phase 2: Gather Reality

Query deployment state:

### For Agents (KAgent)

```bash
# Get all agents and their status
oc get agents.kagent.dev -n ai-platform -o json | \
  jq -r '.items[] | "\(.metadata.name): \(.status.conditions[0].status)"'
```

### For Pods/Services

```bash
# Get running pods
oc get pods -n ai-platform -o json | \
  jq -r '.items[] | select(.status.phase=="Running") | .metadata.name'
```

### For Images

```bash
# Get deployed images
oc get pods -n ai-platform -o json | \
  jq -r '.items[].spec.containers[].image' | sort -u
```

---

## Phase 3: Compare

Cross-reference claims vs reality:

### Mismatch Categories

| Category | Severity | Example |
|----------|----------|---------|
| **False Positive** | CRITICAL | Doc says RUNNING, pod doesn't exist |
| **False Negative** | HIGH | Pod running, doc says PLANNED |
| **Stale Date** | MEDIUM | Validation date > 30 days old |
| **Missing Validation** | LOW | Status without date |

### Output Format

```
===================================================================
              DOCUMENTAT

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
4898 chars