Documentation and notes

Document a stepCopy Anchor Link

A doc: line under a node sets its documentation. It's kept with the node and goes into the BPMN XML as the element's documentation. Documentation is hidden on the canvas.

doc: lines before the first node document the process itself:

process Expense claim
doc: Covers claims up to 5,000 EUR. Larger ones go through purchasing.

start Claim submitted
user Check receipts
  doc: Receipts over 50 EUR need the original paper copy.
  doc: Scans are fine for anything smaller.
service Pay expense
end Expense paid

Each doc: line is one line of the documentation, so write several for a longer description. They always document the node, even when they come after on: lines.

You can also write documentation in the Properties panel.

Add a note to the diagramCopy Anchor Link

For a short remark everyone should see, such as a deadline or a known workaround, add a note: line under the node. The note is drawn above the node and slightly to the right, joined to it by a dotted line, and it's in every export.

process Claim review

start Claim received
user Review claim
  note: SLA 24 hours
  note: Manual for now
  doc: Check the policy, the photos and the repair quote.
end Claim reviewed

Each note: line is one line of the note. A note belongs to a step, event or gateway; arrows, lanes and boundary events can't have one, and there are no notes on their own. In the BPMN XML a note becomes a text annotation joined to its element.

Keep notes to a line or two. A note never replaces a modeled timer or decision: for a deadline the process acts on, use a boundary event.