Editing a Step by step guide

Once your recording is uploaded, the Step by step guide editor opens in the Knowledge base portal. Each step is automatically generated based on the captured workflow, with the step title and description pre-filled from the recorded actions.

Each step displays the captured screen on the left and a right-side pane with editable options. This article covers everything you can do to refine and enhance your guide before publishing

When to use each editing tool

The editing toolkit offers a wide range of features. Understanding when to use each one helps you work more efficiently.

Editing step content

Use the right pane to modify these elements for each step:

• Title - Enter the step title. To add a hyperlink, select the text and click the Hyperlink icon.

• Description - Add instructions or context. Format using Bold, Italic, Underline, ordered list, unordered list, and Hyperlink.

• Slide image - Click Replace image to swap the captured screenshot (maximum 10 MB; supported formats: JPG or PNG; recommended resolution: 1920×892, minimum 100×100).

  • Select from original - Pick a frame from the recorded video. Use fine-tune milliseconds for precision.

  • My uploads - Click Upload to choose a file from your local explorer.

  • Click Insert to apply.

To insert a new step, hover between any two existing steps and click the + icon.

NOTE

The images used in each step are derived from your recorded session. You can choose any frame from the original recording to create a new step or replace an existing image.

Add elements

These tools overlay visual enhancements directly onto the step image.

Blur

Hide sensitive or private information in a screenshot.

1. Click Blur > Add.

2. Ensure the Show blur toggle is on.

3. Enter a name for the blur.

4. Select the step to apply it to. Each blur element is scoped to a specific step. Repeat for other steps as needed.

5. Choose a shape: Circle or Rectangle.

6. Adjust the Intensity (opacity) slider.

7. Click Apply.

To remove a blur, hover over it in the list - click More () > Delete. Click Add new at the top to add more blur elements.

NOTE

You can add multiple blur effects to a single image.

Image

Overlay an additional image onto a step.

1. Click Image > Add.

2. In the My uploads dialog, select a previously uploaded image or click Upload to browse your local files. Predefined image assets are also available.

3. In the Size and position section, choose:

   • Freeform - Adjust size and position freely. Enter an exact value in the Angle field or use Rotate left () or Rotate right () to adjust manually.

   • Fit to screen - The image fills the step's image area by default.

4. Click Apply.

Spotlight

Draw attention to a specific area by dimming everything outside it.

1. Click Spotlight > Add.

2. Enter a name for the spotlight.

3. Select the step to apply it to.

4. Choose a shape: Circle or Rectangle.

5. Click Apply.

To remove, hover over the spotlight in the list - More () > Delete. Click Add new to add more spotlights.

NOTE

All areas outside the spotlight will be dimmed. Currently, you cannot adjust the brightness of the dimmed area.

Text

Add custom text annotations over the step image.

1. Click Text > Add.

2. Enter your text. Format using Bold, Italic, Underline, ordered/unordered list, or Hyperlink.

3. Choose a font and font size.

4. Pick a color from the palette.

5. Set rotation using the degree control.

6. Click Apply.

To edit, click the Edit () icon. To delete, click More () > Delete. Click Add new for additional text elements.

Highlight

Mark important areas on the step image with a colored overlay.

1. Click Highlight > Add.

2. Ensure the Show highlight toggle is on.

3. Enter a Name.

4. Choose a shape: Circle or Rectangle.

5. Select a color from the list or click + to use a custom color.

6. Click Apply.

To remove, hover over the highlight → More () > Delete. Click Add new for additional highlights.

Image transitions

Zoom in effect

Apply a zoom-in effect to draw attention to hotspots or key areas within the step image.

• Click the + button in the top-right corner of the image to zoom in.

• Click the − button to zoom out.

Use this to focus the reader on a small or easily missed element - a checkbox, a toggle, a link without cropping out surrounding context.

Animate click

Instead of a static image, animate a step by playing a short video clip around the recorded click, useful when the result of a click (a dropdown opening, a panel expanding) is important for the reader to see.

1. Select the desired step.

2. In the right pane, go to Image transition.

3. Choose Animate click.

4. Select a duration:

   • 3 seconds - shows 1.5 seconds before and after the click. Best for fast, simple interactions.

   • 5 seconds - balanced; good for most cases where a brief animation is needed.

   • 10 seconds - shows up to 5 seconds on each side; best for slower transitions like page loads or animated UI responses. Duration adjusts based on available footage.

The step plays as a mini video, centered on the click point.

Edit image

Crop

Crop the step image to focus on a specific area.

1. Click Crop.

2. Choose an aspect ratio:

   • Original (320:141)

   • Custom

   • Square (1:1)

   • Landscape (16:9)

   • Portrait (9:16)

3. For Custom, drag the crop area on the image. The Crop output section shows the resulting width, height, and aspect ratio.

4. Click Apply to save.

NOTE

Once cropped, only the selected area will be highlighted and visible in the Knowledge base site.

Managing added elements

To review and manage all enhancements on a step:

1. Expand the Added elements section in the right pane.

2. Hover over any element:

   • Click Edit () to update it.

   • Click Delete () to remove it.

Troubleshooting editing issues

A blur or spotlight I applied isn't showing on the published guide - Check that the Show blur or Show highlight toggle is turned on for the element. Elements are hidden by default until the toggle is enabled, they remain in your editor as saved configurations but won't render on the Knowledge base site until active.

Animate click shows "not available" for a step - Animate click only works for steps whose slide image was taken directly from the original recording. If you replaced the image with a custom upload via My uploads, the animation source is no longer available. Either revert to the original frame using Select from original, or use Zoom in as an alternative.

I cropped a step image but now the reader can't see the surrounding context - Crop is permanent per step. Once applied, only the cropped area is visible. If you need to restore context, click Crop again and select Original as the aspect ratio to revert to the full image.

Text annotations look fine in the editor but are too small on the Knowledge base site - Font sizes that look appropriate on a large editor canvas can render small on different screen sizes. Use a font size of at least 16 - 18px for body annotations and preview the guide on the Knowledge base site before publishing to check legibility.

The "Added elements" section is empty, but I know I applied a blur - Blurs, spotlights, and other elements are stored per step. Make sure you have the correct step selected in the left panel, elements from one step don't appear in the Added elements list of another.

Next steps

Once your guide is polished, you can publish, translate, clone, or manage access. See Managing step by step guides for translation, cloning, unpublishing, and settings.