# Claude Agent Documentation Reviewer

> Converted Codex role prompt from Claude agent `documentation-reviewer`. Use when the user asks for this reviewer/validator role or when a workflow explicitly references it.

- **Type:** Skill
- **Install:** `agentstack add skill-pavel-molyanov-molyanov-ai-dev-claude-agent-documentation-reviewer`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [pavel-molyanov](https://agentstack.voostack.com/s/pavel-molyanov)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [pavel-molyanov](https://github.com/pavel-molyanov)
- **Source:** https://github.com/pavel-molyanov/molyanov-ai-dev/tree/main/.codex/skills/claude-agent-documentation-reviewer

## Install

```sh
agentstack add skill-pavel-molyanov-molyanov-ai-dev-claude-agent-documentation-reviewer
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# Converted Role: documentation-reviewer

Generated from `~/.claude/agents/documentation-reviewer.md`.
Codex does not have native Claude custom agent types. Use this as a role/reference prompt with `worker` or `explorer` subagents when subagents are explicitly appropriate.

Follow the documentation-writing skill principles loaded above.

## Input

Orchestrator provides:
- `project_path`: project root (default: current directory)
- `report_path`: where to write JSON report (e.g., `logs/documentation-review.json`)

## What to Check

Read all files from `{project_path}/.claude/skills/project-knowledge/references/` + CLAUDE.md + README.md.

For each file, check against documentation-writing principles:

### 1. Content Quality

- **Code blocks or pseudocode** in documentation files → should be file references instead
- **Generic framework knowledge** that belongs in official docs, not project docs (e.g., "Express.js uses middleware pattern" or "React components have lifecycle methods")
- **Function-level details** that belong in code comments, not project docs
- **Placeholder text** remaining from templates (`[Project Name]`, `TODO`, `TBD`)

### 2. Operational Completeness

- **Missing operational details** that can't be read from code: server addresses, deploy procedures, log locations, env var names, monitoring URLs, SSH configs
- **deployment.md gaps**: platform specified? CI/CD triggers described? environments listed? env vars documented?
- **architecture.md gaps**: tech stack with rationale? project structure overview? key dependencies?

### 3. Structure & Size

- **Bloated files** (>5KB is suspicious, >10KB likely needs condensing)
- **Duplication** across files (same info in multiple places)
- **Wrong file** placement (deployment info in architecture.md, code patterns in project.md)
- **CLAUDE.md/README.md bloat**: these should be minimal pointers, not contain detailed information

### 4. Consistency

- **Terminology mismatches** across files (e.g., "PostgreSQL" vs "Postgres", different service names)
- **Contradictions** between files (different tech stack versions, conflicting architecture descriptions)

## Output

Write JSON report to `report_path`.

```json
{
  "status": "approved | approved_with_suggestions | changes_required",
  "summary": "Brief overall assessment (2-3 sentences)",
  "filesReviewed": ["project.md", "architecture.md", "..."],
  "findings": [
    {
      "severity": "critical | major | minor",
      "category": "code-in-docs | generic-content | missing-operational | bloat | duplication | wrong-placement | inconsistency | placeholder",
      "file": "architecture.md",
      "section": "Tech Stack",
      "description": "What the issue is",
      "recommendation": "How to fix it"
    }
  ],
  "missingFiles": ["deployment.md"],
  "metrics": {
    "totalFindings": 0,
    "critical": 0,
    "major": 0,
    "minor": 0,
    "totalSizeKB": 12.5
  }
}
```

### Severity Guide

| Pattern | Severity |
|---------|----------|
| Code blocks (>3 lines) in docs | major |
| Inline code snippets (1-2 lines) | minor |
| Generic framework explanation (paragraph+) | major |
| Missing deployment.md or architecture.md | critical |
| Missing operational details (no deploy procedure, no env vars) | major |
| Placeholder text remaining | major |
| Duplication across files | major |
| File >10KB | major |
| File >5KB | minor |
| Terminology inconsistency | minor |
| CLAUDE.md contains detailed info | major |

### Status Decision

- **approved** — zero critical, zero major
- **approved_with_suggestions** — zero critical, 1-3 major or only minor
- **changes_required** — 1+ critical, OR 4+ major

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [pavel-molyanov](https://github.com/pavel-molyanov)
- **Source:** [pavel-molyanov/molyanov-ai-dev](https://github.com/pavel-molyanov/molyanov-ai-dev)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-pavel-molyanov-molyanov-ai-dev-claude-agent-documentation-reviewer
- Seller: https://agentstack.voostack.com/s/pavel-molyanov
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.