Skip to content

Publishing and reviews

Nothing an agent writes goes out on its own. Changes sit as drafts until a person picks them, describes them and publishes them. This guide covers that step, plus review requests and baselines.

Three states to keep straight

State What it means Who sees it
Draft Changed but not published. Counted by the orange n drafts badge. You and your team
Published Approved into the current version, with a revision number and a change note. Your team
Baseline The published state frozen as a numbered product revision. External stakeholders

Publish your changes

  1. Click the blue Publish button in the chat header. The Ready to publish panel slides in from the right.
  2. It lists every changed document, grouped by discipline, each marked Modified, New or Deleted. Tick the ones to publish and untick the rest.
  3. Check Description of changes. Colleag drafts it for you — edit it so it says what actually changed and why. This text is recorded as the change note in each document's revision history.
  4. Choose the Type of change:
    • Technical — a real change to content. Approved documents get a new revision number, for example R1A → R2A.
    • Editorial — wording, formatting, typos. Approved documents get a new letter, for example R1A → R1B.
  5. Click Publish n documents.

Anything you left unticked stays a draft, and the panel tells you so: 2 documents deferred (will remain as drafts).

The numbering follows your scheme

Technical and editorial only appear if your organisation's revision scheme distinguishes them. Simple schemes hide the choice entirely. Set this under Settings → Revisions.

Ask for a review first

At the bottom of the publish panel is Request review before publishing.

  1. Pick the discipline that should review — Quality, Regulatory, Hardware, Firmware, Safety, Test & V&V, Supply Chain or Manufacturing.
  2. Add context for the reviewer if it helps.
  3. Click Request.

The request shows up as the purple n reviews counter in the sidebar for whoever is watching that discipline. Reviews do not block publishing — they are how you get a second opinion before you commit, not a gate the system enforces.

Freeze a baseline

A baseline freezes the current published state as a numbered product revision, with a generated Revision Info document describing what is in it. External stakeholders see baselines, not drafts.

The option appears in the publish panel once there are no draft changes left — you cannot freeze half-finished work.

  1. Publish or discard everything outstanding until the panel reads All documents are published.
  2. Under Freeze baseline, choose Technical or Editorial if your scheme asks.
  3. Write what is new in this baseline. It is optional but it goes into the Revision Info, so it is worth a sentence.
  4. Click Freeze baseline Rn.

Past baselines are listed underneath with their date, approver and document count.

When a freeze is blocked

If open red risks exist, the freeze stops and the panel shows Open risks blocking this freeze with each one listed. You have two choices:

  • resolve or dismiss the risks, then freeze normally; or
  • record a waiver — one reason per line, for example EMC report pending — test booked w34 — and click Freeze with waiver.

Waivers are visible, and that is the point

A waiver does not hide the risk. It is written into the Revision Info as a known deviation, so anyone reading the baseline sees both what was frozen and what was outstanding when you froze it.

Troubleshooting

Problem What to do
Publish is greyed out Nothing is ticked. Select at least one document.
The panel says All documents are published but you just edited something The edit is not saved yet. Look for the orange unsaved dot in the canvas title.
Freeze baseline is not shown You still have drafts. Publish or revert them first.
A document did not get a new revision number Only approved documents are bumped. Drafts publish without a revision change.
The review request seems to have vanished Reviews are per discipline, not per person. Whoever opens that discipline sees the counter.

Next: Standards and SOPs