Skip to main content

How to create a guide

Updated over 4 months ago

1. Starting a Recording

  1. Open the Plugin

    • Click on the dScribe Guide icon in your browser toolbar to open the plugin panel.

  2. Begin Recording

    • In the plugin panel, select the workspace where you would like to save the guide and click 'Start Capturing'.

    • dScribe Guide will now capture a screenshot each time you click or type in your browser.

  3. Walk Through Your Process

    • Navigate through the steps you want to document.

    • For each step:

      • Click on elements (e.g., buttons, links).

      • Type in text fields.

    • The plugin automatically takes screenshots for every interaction.

  4. Finish Recording

    • When you’ve completed all the steps, return to the dScribe Guides plugin pop-up.

    • Click Finish to finish your recording.

2. Editing Your Screenshots in the dScribe Web App

  1. Automatic Navigation

    • After you click Finish, you’ll be automatically navigated to the dScribe web app.

  2. Access Your Recorded Steps

    • Within the web app, you will see a list of the screenshots that were captured.

    • Click on a screenshot to open the image editor.

  3. Using the Image Editor

    • Add Arrows: Click the arrow tool and drag your cursor where you want the arrow to appear.

    • Insert Text: Select the text tool, click on the screenshot, and type your instructions.

    • Redact Sensitive Information: Use the redact (blur or block) tool to hide any personal or sensitive information on the screenshot.


3. Publishing and Sharing Your Guide

  1. Compile Screenshots

    • Arrange the screenshots in the sequence you want them to appear in your user manual.

  2. Add Descriptions

    • Add text descriptions, step numbers, or titles under each screenshot to clarify the process for your readers.

  3. Publish

    • Once satisfied, click Publish to make your guide accessible via a shared link.

Tips & Best Practices

  • Plan Your Steps: Before you start recording, outline the steps to keep your guide concise.

  • Use Clear Labels: When adding text or arrows, be clear and descriptive.

  • Keep Screenshots Clean: Use the redact tool to remove any distracting or sensitive information.

  • Review Before Publishing: Make sure all screenshots and descriptions are accurate and in the right order.

Troubleshooting

  • Plugin Not Visible: Make sure you have pinned the extension to the Chrome toolbar by clicking the puzzle icon and selecting the pin next to dScribe Guides.

  • Screenshots Not Capturing: Ensure you have granted the plugin permission to capture your screen or reload the webpage to sync up the extension.

  • Failed Upload: Check your internet connection or try saving the recording again. If the issue persists, contact dScribe Guides support.

Did this answer your question?