How to Create a Step-by-Step Guide in Scribe

How to Create a Step-by-Step Guide in Scribe

To create a step-by-step guide in Scribe, perform one complete workflow using sample data, then edit the generated instructions before sharing them. Scribe can turn a captured workflow into a series of steps with screenshots and text. Your job is to explain the decisions between the clicks, show what success looks like, and check that the guide reveals only what the reader needs.

Hands typing on a laptop keyboard at a desk
Illustrative photo by Vitaly Gariev on Unsplash.

Define the start and finish

Choose one result that a reader can verify. “Export the weekly sales report as a CSV” is a better scope than “Use the sales dashboard.” Say where the guide begins, what permissions the reader needs, and what they should have at the end. A person who starts from the wrong workspace can follow every click correctly and still export the wrong file. Put the workspace and role in the introduction so they can check both before starting.

Walk through the process yourself and note any step that involves judgment. For the sales report example, one person may know from habit that “last week” means Monday through Sunday in the business’s time zone. A new reader has no reason to know that. Write down the actual rule and identify where it affects the result. Those notes are the parts a capture tool is least likely to supply on its own.

Prepare a safe example before recording

Use a demo account, test workspace or another approved environment with fictional records. Close unrelated tabs and turn off notifications that might interrupt the capture. Check the first page for usernames, customer details, private URLs and other information you would not include in the finished guide. If you are documenting an account setup, begin after the sign-in step or use an approved example that never displays real credentials.

Scribe documents a screenshot editor with manual redaction and a Smart Blur option for supported browser captures. Feature access depends on your setup. Use those controls if needed and inspect every image yourself, including the edges, visible lists and text near the selected control. If a screenshot still includes information you cannot share, replace it with one made with sample data before distributing the guide.

Capture one clean path

Start the capture, follow the shortest valid route and stop when the result is visible. Perform actions at the pace you normally use so you remember where the process feels awkward. If you click the wrong item and go back, mark that spot for cleanup. You may want to remove that detour from the main path and describe it separately as a troubleshooting note.

During editing, make each instruction start with an action and name the control the reader will see. Replace “click here” with something like “Open Reports and select Weekly Sales.” Put the reason in the same step when it affects the decision. For example, tell readers to choose the store before setting the date if changing stores resets the filter. Scribe’s editor supports changes such as revising step text, adding steps and inserting tips or alerts. Keep tips near the place where a reader is likely to need them.

Use screenshots to show what words cannot

Keep an image when it helps the reader find a control, distinguish two similar options or recognize the expected result. A screenshot after every routine click can make a short process feel longer than it is. When a button is visually obvious, a precise sentence may be enough. When the image matters, name the relevant control in the text as well so a reader does not have to rely on an arrow or a color.

Have a new reader try the guide

Ask a colleague with the expected permissions to start from the point named in the introduction. Watch where they hesitate. If they ask which filter to choose, add the rule at that step. If they reach the right screen but cannot tell whether the work is finished, add a check such as “Open the exported file and verify the store name and reporting dates.” Confirm that the intended recipients can access the guide before sending it more widely.

Give the guide an owner and review it when the interface or procedure changes. If the task is easier to teach in motion, such as a multi-step design edit, a short video can complement the written steps. See KINSMC’s guide to editing video from a transcript for a way to keep that recording concise and captioned.

Sources

  1. Scribe Support: Editing a Scribe
  2. Scribe Support: Redact sensitive information