- Documentation
- Workflows
- Document a workflow with sticky notes
Document a workflow with sticky notes
Add resizable Markdown sticky notes to the canvas to explain a workflow for teammates and clients, without changing how it runs.
What sticky notes are for
A sticky note is a free-floating annotation on the workflow canvas. Use one to explain why a branch exists, leave a runbook next to the steps it covers, or hand a workflow to a teammate or client with the context written where they'll actually read it.
Notes are pure documentation. They never connect to nodes, never run, and never affect publishing or validation. A workflow with fifty notes compiles to exactly the same runs as the same workflow with none.
Add a note
In the editor's top-left toolbar, click the Add note button (the sticky-note icon, next to Add node), or press Shift+S. The shortcut is ignored while you're typing in a field.
The note appears at the center of your view, selected, with the editor open. Type your content, then click anywhere outside the note (or press Escape) to save it. Note edits count as unsaved changes, so save the workflow as usual when you're done.
A workflow can hold up to 50 notes. At the cap, the button and shortcut do nothing and the editor tells you the limit was reached.
Write in Markdown
Note bodies render Markdown, including tables, task lists, and strikethrough. Each note holds up to 10,000 characters; a counter appears while editing once you approach the cap.
## Order triage
Orders over $500 take the **review path**.
- [x] Slack alert wired to #high-value
- [ ] Add the refund follow-up
| Path | Owner |
| ------ | ----- |
| Review | Dana |
| Auto | none |A few behaviors to know:
- Links open in a new tab.
- Images are not embedded. Image syntax renders its alt text only, so a note can never load content from an outside URL.
- Raw HTML is never rendered. Tags you type appear as plain text.
- Code blocks render in monospace and scroll horizontally when long.
Pick a color
Select a note, then click the palette icon in its header and choose one of six colors: amber (the default), blue, green, pink, purple, or slate. Color is a quick way to give annotations meaning, such as amber for context, pink for warnings, and slate for parked ideas. Colors stay legible in light and dark themes.
Move and resize
Drag a note by its header strip. The body is not a drag target, so you can never grab a note when you meant to grab the node on top of it. To resize, select the note and drag any edge or corner of its frame. Notes resize between 140 x 80 and 2,000 x 2,000 pixels, which is large enough to sit behind an entire section of a workflow as a labeled backdrop.
Notes always render behind nodes and edges, in every state: selected, dragging, or idle. A note can never cover up a step.
While a note is unselected, clicks and drags on its body fall through to whatever is underneath. You can box-select nodes sitting on a note, click a node through it, and pan the canvas across it. Only the header is interactive until you select the note.
Edit an existing note
Double-click the note's header to reopen the editor. With the header focused, Enter or Space does the same from the keyboard. While a note is selected, its body becomes interactive too: you can select and copy its text, or double-click the body to edit.
The editor also never auto-moves a note. Inserting nodes between steps shifts the affected nodes, but your annotations stay exactly where you put them.
Delete a note
Select the note and either click the trash button in its header or press Backspace. Deleting a note never touches any node or connection.
Notes travel with the workflow
Notes live in the workflow itself, so they:
- survive reloads and edits,
- carry over when a new version is created from an active workflow, and
- are included when you save a workflow as a template, which makes notes the right place to leave setup instructions for whoever instantiates it.
Because notes are not steps, they never show up in the data-mapping reference picker, and publishing treats a noted workflow exactly like an unannotated one.
Limits
| Limit | Value |
|---|---|
| Notes per workflow | 50 |
| Characters per note | 10,000 |
| Minimum size | 140 x 80 pixels |
| Maximum size | 2,000 x 2,000 pixels |
TaskJuice enforces every limit in this table when you save, so a workflow can never store an over-limit note.
Next steps
- Build a workflow - The end-to-end editor walkthrough.
- How versions keep a live workflow safe to edit - Notes ride along on every version.
- Save a workflow as a template - Package an annotated workflow for reuse.