Reviews

Reviews provide a formal review process for documents. They support participant roles, per-item opinions, comments, and checklists. Reviewing happens inside the document editor; the Reviews pages give you the overview and management surface.

Creating a Review

Reviews are started from the document you want reviewed:

1. Open the document in the editor
2. On the ribbon’s Review tab, click Start review (or New if the document already has reviews)
3. Enter a title (prefilled as Review: <document title>) and an optional description
4. Add participants as Reviewer or Observer — you are added as the review Lead automatically
5. Click Create Review

The review captures the document’s current commit as its starting point, so the protocol can later show exactly what changed during the review.

Reviewing in the Document

Open an in-progress review via Open in Document on the review detail page, or from the editor’s Review tab. In review mode:

• Select an item and record your opinion with the OK / Has issues buttons in the ribbon
• Add comments with New comment
• The gutter shows everyone’s aggregated opinions on the left margin and your own on the right
• Opinions and comments are saved together with the document Save
• Fill in allocated checklists in the side panel

Participants

Role	Purpose
Lead	Runs the review; the creator becomes Lead automatically
Reviewer	Provides opinions and comments on items
Observer	Follows the review without being expected to opine

Participants can be added or removed while the review is open. Managing reviews (starting, closing, cancelling, editing participants) additionally requires review permissions in the workarea — see Roles & Permissions.

Review Lifecycle

Status	Description	Available Actions
Preparing	Scope and participants are being configured	Start Review
In Progress	Reviewers examine items and provide opinions	Close Review, Cancel
Closed	Review is complete, protocol generated	View Protocol
Cancelled	Review was cancelled before completion	—

Note: Use the Close Review button to finish a review — it records the closing commit and generates the protocol.

Opinions

• OK — The item meets requirements
• Has Issues — The item needs changes

Summary cards on the review detail page count items by outcome; an item with both OK and Has-Issues opinions counts as having issues.

Comments

Reviewers can add markdown comments to individual items or to the document as a whole. Comments can be marked as resolved (shown with a checkmark); the review detail page displays the total and unresolved counts.

Checklists

Reviews can include checklists allocated as:

• Entry criteria — Expected to be complete before the review starts
• Exit criteria — Expected to be complete before the review closes
• Per-item checklists — Applied to specific items in the review

Each checklist tracks completion with a progress bar. Incomplete entry/exit criteria produce warnings when starting or closing — they do not block.

Review Detail Page

The detail page shows:

• Header — Title, status, workflow actions, and the Open in Document button
• Summary cards — OK, Has Issues, Comments, and Opinions counts
• Description — Markdown-formatted review description
• Review Period — the start and close commits that pin the review’s scope
• Checklists — Entry/exit criteria with completion tracking
• Comments — List with author, date, and resolved status
• Sidebar — Participants with role badges and the linked document

Review Protocol

After closing a review, a protocol is generated summarizing per-item opinions and comments, checklist completion, and what changed during the review period. See Review Protocol.