Ia Document Review

Document Review

Improve brainstorm or plan documents through structured review.

Working rules

• Assess before editing, preserve implementation-relevant constraints and rationale, and distinguish minor edits from substantive decisions.
• A review-only request authorizes findings, not file edits. Apply changes only when the user has requested editing or approved the proposed changes; do not ask again for changes already authorized.

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?
• Is this technically feasible with the current architecture?
• Are there security implications in what's proposed?

These questions surface issues. Note findings without fixing yet.

Step 3: Activate Review Lenses

Based on the document's content, activate specialized review perspectives. Scan for signals and apply matching lenses:

Activate a lens when ANY of its signals match. Most documents trigger 1-2 lenses; brainstorm notes may trigger none. When a lens is active, weave its checks into the assessment and evaluation steps rather than running it as a separate pass.

Step 4: Evaluate

Score the document against these criteria:

If invoked within a workflow (after /ia-brainstorm or /ia-plan), also check:

• User intent fidelity -- Document reflects what was discussed, assumptions validated

Step 5: Identify the Critical Improvement

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

Step 6: Make Changes

Present findings, then:

1. Apply authorized edits within the requested scope, including minor wording and formatting fixes. For review-only requests, report these as suggestions.
2. Ask approval for changes outside the existing authorization (restructuring, removing sections, changing meaning). Use the active harness's supported approval interface, or ask directly in chat. Render the finding per the contract below before asking so the decision is concrete.
3. Update the document inline only for authorized changes; otherwise return the findings.

Rendering a finding for decision

The reader deciding on a finding does not have the document open and has not memorized its identifiers. This binds the approval track only (step 2 above) -- findings routed to auto-fix in step 1 skip it. Any finding presented for approval is rendered in this order:

1. Consequence if unchanged -- one sentence: what goes wrong, and for whom. No identifier the reader would have to look up.
2. Recommended action, marked unmistakably.
3. Change intent -- one sentence.
4. Mechanism -- at most two sentences, carrying at most two opaque anchors (defined below).

Anything deeper (file tracing, multi-hop call paths, competing call sites) is not printed; offer it in one closing line. Budget: two inline code spans per sentence, no diff blocks, raw code blocks only for genuinely additive content of five lines or less.

Classify opaque anchors by what they do, not by vocabulary:

• Navigation anchors (IDs the document itself defines) keep the ID and gain a short handle at first mention -- R6 (suppress peer panels on low-stakes calls), never a bare R6.
• Provenance anchors (ticket IDs, PR numbers) get a role gloss only when the referenced event changes the decision; otherwise move them to the trace.
• Mechanism anchors (function, file, line names) translate to the role they play in the decision -- "the terminal-failure predicate" -- keeping the exact symbol only when precise scope is what the decision turns on.

A finding whose only route to a decision is "go read the section" has failed, however correct it is.

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 8: 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. If the user wants to continue, allow up to 4 passes total. After 4, stop and report "review converged -- further changes require new direction." Do not continue past 4 even on user request without a fresh framing.

Withdraw what earlier answers already settled. On pass 2 and later, judge each remaining finding against the decisions already made this session before presenting it. If an earlier answer resolves or contradicts it, do not re-raise it: say in one line what the finding was and which answer retired it, then move on, and record it as withdrawn in the summary with the retiring decision named. The distinction that matters -- a withdrawal caused by a user decision (a skip, a defer, an asserted fact) is durable and suppresses the finding on every later pass; a withdrawal caused by a pending fix is provisional, because the fix can fail or land in the wrong place, so a finding that regenerates on the next pass must resurface rather than stay suppressed. Evaluate lazily, at the moment the finding would have been presented; do not rescan after every answer. (Code review carries the same rule -- see ia-code-review on reconciling prior discussions.)

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

Constraints

• Fix targeted sections, don't rewrite the whole document. If the structure is fundamentally broken, surface the structural problem and ask for permission to restructure.
• Flag missing sections in the review, but don't add them. The user decides what to include.
• Keep changes minimal. If a paragraph needs tightening, tighten it. Don't expand scope.
• Review inline. No separate review files or metadata sections.

Success Criteria

• Document read and scored on all four quality criteria
• Relevant review lenses activated and checks applied
• Critical improvements identified with specific suggestions
• User presented with clear next-action choice (refine or complete)
• Revised document saved if changes were approved

Task-specific references

Read the relevant reference before implementing or reviewing the matching behavior:

• For an optional zero-context reader test of a standalone document: reader-test.md.