Skip to main content

The Document Editor

In the Document Editor you can refine the written step-by-step guidde by editing the text, images, and layout independently of the video.

Updated over a week ago

Enter the Document Editor

When a step-by-step guidde is captured, both a video and a written document are automatically generated. Right after capturing, you’ll land on the view page, where you can preview both. The view page is read-only; from here, you can access either the video editor or the document editor.

Note: Video steps without narration are automatically hidden in document view for a clean, focused reading experience.

1. From the guidde view page, click Edit in the top corner to open the editor.

Alternatively, you can click the three-dot menu on a video’s top right on your Guidde homepage, and select Edit in the opened menu.

3. Once inside the editor, you’ll see two sections above the video: Video and Document. Select the Document tab to begin editing your written step-by-step.

  • When entering the editor, you'll land in the Video editor by default.

preview

4. Scroll down to review your document steps.

Click the eye icon at the top left of a step to hide it from the published document. This allows you to remove the step from the document without deleting it or detaching the video. Hidden steps remain in the editor and can be shown again at any time.

Edit the Document: Detached or Synced Mode

1. You can change the title of your guidde from the editor by clicking it and typing in the title on the top left (both from the video and the document editor sections).

  • You can update the title directly without opening the editor: Open the guidde and click the title field above the video, enter your new title and click enter to save.

  • Note: Making any of the changes listed below will detach the video from the document.

2. Use the table of contents on the left to navigate your document - it can’t be edited directly from the panel. To update it, edit the step titles in the document or adjust them in the video editor’s Speaker section (if your doc and video are synced). Learn more here.

preview

3. By default, the document content is synced with your video. You can see the sync icon on the top right. When synced, any changes you make to your video steps will be reflected in the document, even before you publish.

preview

4. Once you edit the document directly, it will detach from the video. The sync icon will show a line through it, and a confirmation popup will ask if you wish to proceed.

This includes actions such as:

  • Replace image

  • Delete image

  • Adding or deleting steps

  • Editing step titles or text

  • Editing the image

  • Adding ALT text

  • Reordering steps

Any other changes made inside the document editor

preview

Edit the Step Content

5. When editing your step-by-step document in detached mode, you can remove, add steps, or modify any step in the document without affecting the video. Simply click the pencil icon on the right or edit directly within the step by clicking it.

6. When editing a step in the document, you can:

  • Update the title (which will also affect the table of content)

  • Set the document's Text format and color

  • Edit the description

  • Edit or delete the step image

Note: While you currently cannot adjust the text size in the document, you can apply different text formats such as headings to visually structure your content.

7. To edit or delete an image in a document step, click into the step and use the menu at the bottom-right corner of the image, where you can: Crop, add image ALT text, replace an image or delete an image.

8. When cropping an image in the document, the image cropper window opens, allowing you to crop, rotate, delete, or reset images to their original state.

preview

9. To add ALT text description to your image, click the ALT icon at the bottom right corner of your image.

Add image ALT text

In the opened field, type in your ALT text description.

Type in image ALT text
  • Alt text translates when you translate your guidde.

  • Works across all formats: HTML, PDF, Word, Markdown.

Note: Alt text is automatically generated from the step title. You can customize it in the document editor, however doing so will detach the document from the video.

Pro tip: To update alt text while keeping the video and document synced, edit the video’s step titles (in the video editor) - these changes will be reflected in the document's alt text without detaching the content.

10. Replace any image in your document by uploading a new file or selecting a step from your Guidde video.

  • Click the Replace icon at the bottom of the image.

  • Choose whether to upload an image or select a step from your Guidde video.

  • When you select “Choose Image from Video”, a window opens where you can choose the step you want. Click the desired step, then select Import image at the bottom to add it to your document.

  • There’s no need to re-attach the document to the video to replace an image - just click Done to save your changes.

Manage Changes

9. Undo/Redo actions work separately in the video and document sections.

10. If you want to sync your document back with the video, click the sync icon.

  • Note: Syncing the document back with the video will overwrite the document with the video’s content, so any changes made to the document while detached, will be permanently lost.

11. A confirmation message will appear, allowing you to review before proceeding.

preview

Document Image Appearance: Brand Kit Settings

Document images may display different visual elements than your video steps, depending on your Brand Kit settings: Callouts, arrows, and overlays can be toggled on or off from your video/document under Brand Kit → Step Appearance.

For example:

  • Note: The Brand kit settings should ideally be configured before capturing your video, for an optimal experience.

  • If you want to apply Brand Kit settings to a captured guidde after creating it: Access the editor and click the three dots on the upper right. Select "Set Brand Kit" from the menu, this will apply the current brand kit settings to your video and document. Note that this may not update every adjustment.

preview

Auto-Save and Publish your Guidde

Your edits are saved automatically in the background as you work. They remain in draft mode and won’t be visible to others until you publish your guidde.

12. When you’re ready to publish and finalize your changes, click "Done", it publishes both the video and document changes.

That's it! With the Document Editor, you can refine and adapt your step-by-step written content for any purpose. Share it with your team or customers in just a few clicks, making knowledge distribution quick, simple, and efficient.

Did this answer your question?