home/writing/review-docs-goal

Review Docs.goal

GPTClaudeGemini··▲ 1,196 copies·updated 2026-07-14

review-docs-goal.prompt

# Claude Code Goal: Review Documentation

## Target Tool

Claude Code, used here in a read-only reviewer role (not as an editor).
Works whether invoked from the CLI, an IDE integration, or a `/goal`-style
custom slash command defined in `.claude/commands/`.

## Purpose

Use this prompt for read-only documentation review. Claude Code should
identify clarity, safety, consistency, and verification issues before a
maintainer edits or merges docs, without making any edits itself. This is
the review gate you run before a docs PR is opened, or as a second pass on
an existing PR before merge.

## Inputs To Fill

| Input | Description | Example |
| --- | --- | --- |
| `{docs_to_review}` | Exact files or globs to review. | `README.md`, `docs/tools/*.md` |
| `{audience}` | Reader and prior knowledge level. | `Beginner Windows users with basic Git knowledge` |
| `{main_risks}` | Specific risks to prioritize in this pass. | `Unverified AI tool pricing/availability claims` |
| `{allowed_edits}` | Whether any edits are allowed after review. | `None - findings only` |
| `{base_context}` | Files that establish house style/rules. | `AGENTS.md`, `README.md`, `CONTRIBUTING.md`, `SECURITY.md` |

## Full Prompt

fill the variables

This prompt has 5 variables. Pro fills them into a ready-to-paste prompt for you — no manual find-and-replace.

{docs_to_review}{audience}{main_risks}{allowed_edits}{base_context}

Unlock with Pro →

when to use it

Community prompt sourced from the open-source GitHub repo Yaked1/ai-lab-codex-workbench (MIT). A "Review Docs.goal" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.