---
name: review-document
description: Turns a review's findings into one short Markdown document a reader can act on, with the verdict first and each finding ranked, located, backed by evidence, and paired with its fix. Use when writing up a code review, a design or QA review, or an audit, where the reader must decide what to do about what you found.
license: MIT
title: review-document
canonical_url: https://skilld.dev/gh/onmax/comark-ui/review-document
last_updated: 2026-11-12T13:04:21.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [agents/openai.yaml](https://skilld.dev/api/skills-raw/onmax/comark-ui/review-document/agents/openai.yaml), [references/blocks.md](https://skilld.dev/api/skills-raw/onmax/comark-ui/review-document/references/blocks.md), [references/example.md](https://skilld.dev/api/skills-raw/onmax/comark-ui/review-document/references/example.md).
>
> If the user asked to install this Skill, run `npx skilld install onmax/comark-ui/review-document`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/review-document`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/onmax/comark-ui/review-document) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/review-document`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/review-document --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/review-document --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Review document

A review's reader has one question: what do I do now? Answer it in the first two lines, then give each finding just enough evidence that the reader trusts it without redoing your work. This skill organizes findings you already have; finding them is the review itself.

Length is the usual failure. A reader who has to dig through praise, process, and restated findings misses the one that blocks the merge. Every line below the verdict either supports a finding or says what you didn't check.

## 1. Decide the verdict

Pick one: **approve**, **approve with changes**, **request changes**, or **blocked** on a named thing. Under it, write the reason in one sentence that names the finding behind it.

Done when someone who reads only the verdict knows what to do.

## 2. Keep the findings that change the decision

- Keep a finding when fixing it, or not, changes what the reader should do.
- Merge findings with one root cause into one, and list every place it appears.
- Rank each one: **blocking** (wrong results, lost data, a security hole, broken for users), **should fix** (a real cost that can wait), or **nit**, only when the reader asked for them.

Order them blocking first. Done when every finding has a rank and no two share a cause.

## 3. Back each finding

Each finding is four parts, in this order:

1. **A title that states the consequence**, for whom: "Small avatars load the 512px image", not "Cache key issue".
2. **Where**: the file and line, linked when there's a URL.
3. **Evidence**, the strongest you have: a failing test or command you ran (`::tests`, a fenced block of output), a screenshot of the wrong state (measured as the before-after-evidence skill describes), the lines that cause it (a fence with the line highlighted), then reasoning. Say which it is: a finding you reproduced reads differently from one you read in the code.
4. **The fix**: a `::diff` of the smallest change, or one sentence when the fix is a decision for the reader.

Done when every blocking finding has evidence you ran or captured, or says plainly that it comes from reading the code.

## 4. Say what you checked

End with two short lists: what you checked and how, and what you didn't check. A review that implies more coverage than it had loses the reader's trust in the parts that were real.

## 5. Write it

Follow [references/example.md](https://skilld.dev/api/skills-raw/onmax/comark-ui/review-document/references/example.md):

- The verdict in a callout: `> [!CAUTION]` for request changes or blocked, `> [!WARNING]` for approve with changes, `> [!TIP]` for approve.
- One `##` heading per finding, numbered, with its rank in the heading. About a dozen lines each, evidence included.
- No summary that repeats the findings, no section for an empty rank, no list of what's good unless the reader asked.

[references/blocks.md](https://skilld.dev/api/skills-raw/onmax/comark-ui/review-document/references/blocks.md) has the syntax for the callout, `::tests`, `::diff`, and highlighted lines.

## 6. Check the render

1. Lint it, and fix until it reports no problems:

   ```sh
   vp dlx --package comark-linter --package comark-ui comark-lint review.md
   ```

   These commands use the [global Vite+ CLI](https://viteplus.dev/guide/global-cli). Without it, `pnpm dlx` takes the same arguments.

2. Open the rendered page where it will be read and read it top to bottom as the reader would. Each finding's evidence should be visible without expanding anything except a long log, and each `::diff` should start at the line its finding names.

Done when the page renders without problems and you've read it once as the reader.
