Review Protocol
The review protocol is a generated summary created when a review is closed with Close Review. It provides a formal record of the review outcomes.
Accessing the Protocol
- Open a Closed review from the Reviews list
- Click View Protocol in the review actions
Protocol Contents
Summary Cards
Counts across the reviewed document: OK, Issues, No Opinion, Comments (with the unresolved count), and Changes (items added, modified, and deleted during the review period).
Item-by-Item Summary
For each item in the reviewed document:
- Opinions from each reviewer (OK or Has Issues)
- Comments associated with the item
- Change status — whether the item was added, modified, deleted, or unchanged between the review’s start and close commits
Items with issues, comments, or changes are expanded by default; expand/collapse-all controls are at the top of the list.
Checklist Completion
The Checklists Used section summarizes all allocated checklists, grouped as Entry Criteria, Exit Criteria, and Per Item, with required-vs-total completion for each.
Review Period
The review is pinned to git commits: the start commit captured when the review was created and the close commit recorded at closing. The protocol shows both (as shortened commit IDs), the participant list with roles, and when the protocol was generated.
Tools
- View at close — opens the reviewed document exactly as it was at the close commit
- Regenerate — rebuilds the protocol against the original close commit (requires review-close permission)
Using Protocols
Review protocols serve as formal evidence that a review was conducted. They are stored in Git alongside your workarea data, providing a permanent audit trail. Use protocols to:
- Demonstrate compliance with review requirements
- Reference review outcomes in future discussions
- Track what feedback was given on specific items