home / skills / everyinc / compound-engineering-plugin / document-review

This skill helps refine brainstorm or plan documents through structured review, ensuring clarity, completeness, and actionable next steps.

npx playbooks add skill everyinc/compound-engineering-plugin --skill document-review

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
3.1 KB
---
name: document-review
description: This skill should be used to refine brainstorm or plan documents before proceeding to the next workflow step. It applies when a brainstorm or plan document exists and the user wants to improve it.
---

# Document Review

Improve brainstorm or plan documents through structured review.

## Step 1: Get the Document

**If a document path is provided:** Read it, then proceed to Step 2.

**If no document is specified:** Ask which document to review, or look for the most recent brainstorm/plan in `docs/brainstorms/` or `docs/plans/`.

## Step 2: Assess

Read through the document and ask:

- What is unclear?
- What is unnecessary?
- What decision is being avoided?
- What assumptions are unstated?
- Where could scope accidentally expand?

These questions surface issues. Don't fix yet—just note what you find.

## Step 3: Evaluate

Score the document against these criteria:

| Criterion | What to Check |
|-----------|---------------|
| **Clarity** | Problem statement is clear, no vague language ("probably," "consider," "try to") |
| **Completeness** | Required sections present, constraints stated, open questions flagged |
| **Specificity** | Concrete enough for next step (brainstorm → can plan, plan → can implement) |
| **YAGNI** | No hypothetical features, simplest approach chosen |

If invoked within a workflow (after `/workflows:brainstorm` or `/workflows:plan`), also check:
- **User intent fidelity** — Document reflects what was discussed, assumptions validated

## Step 4: Identify the Critical Improvement

Among everything found in Steps 2-3, does one issue stand out? If something would significantly improve the document's quality, this is the "must address" item. Highlight it prominently.

## Step 5: Make Changes

Present your findings, then:

1. **Auto-fix** minor issues (vague language, formatting) without asking
2. **Ask approval** before substantive changes (restructuring, removing sections, changing meaning)
3. **Update** the document inline—no separate files, no metadata sections

### Simplification Guidance

Simplification is purposeful removal of unnecessary complexity, not shortening for its own sake.

**Simplify when:**
- Content serves hypothetical future needs, not current ones
- Sections repeat information already covered elsewhere
- Detail exceeds what's needed to take the next step
- Abstractions or structure add overhead without clarity

**Don't simplify:**
- Constraints or edge cases that affect implementation
- Rationale that explains why alternatives were rejected
- Open questions that need resolution

## Step 6: Offer Next Action

After changes are complete, ask:

1. **Refine again** - Another review pass
2. **Review complete** - Document is ready

### Iteration Guidance

After 2 refinement passes, recommend completion—diminishing returns are likely. But if the user wants to continue, allow it.

Return control to the caller (workflow or user) after selection.

## What NOT to Do

- Do not rewrite the entire document
- Do not add new sections or requirements the user didn't discuss
- Do not over-engineer or add complexity
- Do not create separate review files or add metadata sections

Overview

This skill refines brainstorm or plan documents to make them ready for the next workflow step. It locates or accepts a specified document, evaluates clarity and completeness, and produces targeted edits and recommendations. The goal is to preserve intent while removing unnecessary complexity and surfacing critical gaps.

How this skill works

The skill first reads the provided document or finds the most recent brainstorm/plan in docs/brainstorms/ or docs/plans/ if none is supplied. It performs a two-stage review: an assessment that identifies unclear language, missing assumptions, and scope risks, then an evaluation that scores clarity, completeness, specificity, and YAGNI. It highlights the one critical improvement to address, auto-fixes minor issues, and asks for approval before making substantive changes inline.

When to use it

  • You have a brainstorm or plan and want it polished before planning or implementation.
  • You suspect the document contains vague assumptions or scope creep risk.
  • You need a quick pass to make a draft actionable for the next workflow step.
  • You want targeted edits without rewriting or adding new requirements.

Best practices

  • Provide a document path when available to avoid extra prompts.
  • Allow the skill to auto-fix only minor wording and formatting issues.
  • Approve substantive changes before they are applied inline.
  • Focus edits on making the document sufficient for the immediate next step.
  • Limit major restructures—iterate multiple small refinements instead.

Example use cases

  • Turn a brainstorm into a plan-ready brief by clarifying goals and assumptions.
  • Polish an implementation plan so it contains concrete acceptance criteria and constraints.
  • Remove hypothetical features and simplify scope to match current priorities.
  • Identify unstated decisions and highlight the single most impactful fix before proceeding.

FAQ

Will this skill rewrite my document?

No. It avoids full rewrites and will not add new sections or requirements you didn’t discuss.

What kinds of fixes are applied automatically?

Minor edits like vague wording, grammar, and formatting are auto-fixed; structural or meaning-changing edits require your approval.