Guide

Edit Workflow Documentation

browzer9 stepsAgent View (JSON)

Overview

Workflow documentation serves as the authoritative guide for users executing automated browser tasks. Clear, well-annotated documentation reduces errors, prevents unintended consequences, and helps users understand critical prerequisites or gotchas. This workflow enables you to enhance existing documentation by adding warning annotations (for risky or destructive actions) and note annotations (for helpful context, tips, or business-critical information). By systematically adding these annotations, you improve documentation quality and reduce user support burden.

Before you begin

  • Active user account on trybrowzer.com with permissions to edit workflow documentation
  • Access to the Workflow Documentation section of trybrowzer.com
  • Identification of the specific AI workflow task you want to enhance (e.g., 'Adds a new member to a team')
  • Clear understanding of which steps require warning annotations and which need note annotations

Step by step

1
ClickWorkflow Documentation

Navigate to the Workflow Documentation section of trybrowzer.com by clicking the Workflow Documentation link in the main navigation. This takes you to the hub where all AI workflow tasks and their documentation are organized.

Step 1
2
ClickAI: Adds a new member to a team on trybrowzer.com by navigating to the Team section, clicking Invite Member, entering an email address, and sending the invitation.

Select the specific AI workflow task you want to edit by clicking on its title or description. In this example, click on the 'AI: Adds a new member to a team on trybrowzer.com...' task to open its full documentation.

Tip. Use the search or filter functionality if the workflow list is long, to quickly locate the task you want to enhance.
Step 2
3
ClickEdit

Click the Edit button to enter edit mode for the selected workflow's documentation. This unlocks the ability to add, modify, and remove annotations.

Step 3
4
ClickWarning

Click the Warning button to begin adding a warning annotation. Warnings flag critical risks, destructive actions, or safety concerns that users must understand before executing a workflow step.

Tip. Use warnings sparingly and only for genuinely risky actions (e.g., 'This will delete all data' or 'This action cannot be undone'). Overuse diminishes their impact.
Step 4
5
ClickAdd warning...

Click on the 'Add warning...' textbox to focus it and prepare it for input. This textbox is where you will type the warning message that users should see.

Step 5
6
TypeAdd warning...

Type your warning message into the textbox. Be concise and direct; for example: 'This action will permanently remove the user from the team with no undo option' or 'Ensure you have team admin privileges before proceeding.'

Tip. Keep warning text brief (1–2 sentences) so users quickly grasp the risk without reading long blocks of text.
7
ClickNote

Click the Note button to begin adding a note annotation. Notes provide helpful context, tips, best practices, or supplementary information that enhance user understanding without flagging a risk.

Tip. Use notes for clarifications like 'You can invite multiple users by entering comma-separated email addresses' or 'The invited user will receive an email within 5 minutes.'
Step 7
8
ClickAdd note...

Click on the 'Add note...' textbox to focus it and prepare it for input. This textbox is where you will type the note message.

Step 8
9
TypeAdd note...

Type your note message into the textbox. Keep it informative but concise; for example: 'The invited user must have a valid email address and will automatically join the team upon accepting the email invitation.'

Tip. Notes should add genuine value—avoid redundant information already present in the main workflow description.

Confirm it worked

  1. 1The workflow documentation page displays the selected AI task with the Edit button visible
  2. 2Warning annotation(s) appear visibly in the documentation after being added
  3. 3Note annotation(s) appear visibly in the documentation after being added
  4. 4Both warning and note text persist in the documentation after the workflow completes (confirming save)

Common issues

Keep reading

Contributors

R
Rahul Arulkumaran