Editing Rich Text Instructions in Onboarding Templates

Every onboarding step can include instructions that appear prominently above the input field. These instructions help guide your onboardees through the process, explain what's required, or draw attention to important information they need to know before proceeding.

The rich text editor gives you full control over how these instructions look, allowing you to format and emphasise text so key details don't get overlooked.

Accessing the Instructions Editor

When editing an onboarding step template, click the Edit Instructions button to open the rich text editor. Here you can write and format the guidance that will appear to onboardees when they reach this step.

You can also drag the window from the bottom right hand corner, to make the instructions pane bigger (height) if required when editing.

Formatting Options

The editor includes a comprehensive toolbar for formatting your instructions:

Text Styles

  • Normal and Heading options via the style dropdown — use headings sparingly to highlight section titles or critical warnings

  • Bold, Italic, and Underline — emphasise important words or phrases

Text Colour

  • Change the colour of selected text to draw attention to specific information

  • Useful for highlighting warnings, deadlines, or mandatory requirements

Lists

  • Numbered lists for sequential steps

  • Bullet points for requirements or checklists

Alignment

  • Left, centre, right, and justified alignment options

  • Centre alignment works well for short, prominent notices

Best Practices

Keep it concise. Instructions appear at the top of each step, so keep them focused. If onboardees see a wall of text, they may skim past important details.

Use formatting purposefully. Bold text and colour changes are effective when used sparingly. If everything is emphasised, nothing stands out.

Be specific. Rather than "Enter your name", try "Enter your surname exactly as it appears on your driver's licence". Clear instructions reduce errors and support requests.

Consider your audience. Write instructions that make sense to someone unfamiliar with your processes. Avoid jargon unless your onboardees will understand it.

Character Limit

Instructions have a 2,000 character limit, which is plenty for clear, focused guidance. If you find yourself approaching this limit, consider whether all the information is essential or if some details could be provided elsewhere. Also consider compiling longer instructional documents into a clickable PDF file which has not such character limit. Providing a PDF file instead of text instructions is a great way to get around the character limit if you absolutely have to.

Examples

Simple guidance:

Please enter your mobile phone number including the area code. We'll use this to send you important updates about your onboarding status.

Emphasised requirement:

Important: Your White Card must be current and valid. Expired cards cannot be accepted.

Step-by-step instruction:

To upload your document:

Take a clear photo or scan of your certificate Ensure all text is legible and the entire document is visible Upload as a PDF, JPG, or PNG file

Rich text instructions help create a smoother onboarding experience by providing clear guidance exactly where your onboardees need it.

Previous
Previous

Why WorkZerk Doesn't Support iOS 12 Devices

Next
Next

Download Onboarding Data External Integrations