Open the guide from its project. Select a step to work on its instructions and screenshot. Editing controls depend on your access; ask the project owner if you can view the guide but cannot change it.
Refine the content
Edit a step descriptionExample with sample data
Example with sample data: the description editor and its real formatting controls. The surrounding task and editable text are illustrative. Choose Save description to keep your text.
Keep each instruction specific and easy to follow.
Use lists and emphasis where they improve clarity.
Save the description, then review the step in context.
Update the guide title and step titles so each names a specific task or action.
Edit step descriptions with the available rich-text controls. Write the action first, followed by the expected result where helpful.
Use Add step at the intended position, then choose Write manually or Append from recording. Use the step’s actions to move or delete it, then check the resulting sequence.
Use sections to group related steps and Add callout to add relevant information or warnings. Complete callout text before saving.
Use Ask AI when you want help rewriting a step. Review the suggested text for accuracy before keeping it.
Save each open edit with its Save control, such as Save description. Wait for the saving status to confirm completion before leaving the editor. If a draft or save warning appears, follow saving and draft recovery.
Edit the workflow overview
Choose Overview in the guide header. In Workflow Overview, choose Edit overview or the edit control beside the summary or section.
Select Summary or a section in the left-hand list. Edit its text; use Add section and the section's move or remove controls to organise the overview.
Use Compare saved to check your draft against the saved overview. A reset control restores only that summary or section's AI default in the draft. Preview generated overview stages all available AI defaults for review.
Choose Save overview to apply the changes, or Cancel changes to discard the draft. Wait for Overview saved before closing.
Important
Resetting, rearranging or removing overview content remains a draft until Save overview. Removing the overview keeps the guide's steps and recordings. If a conflict appears, choose Load latest for comparison and review both versions before saving.
A useful instruction
Instead of “Click here”, write “Open Settings, choose Appearance, then select the theme you want.” Use the names visible in the application being documented and include any prerequisite that a new reader would need.
Example with sample data
Example using sample data: “Open Settings, choose Appearance, then select Light. Confirm that the page changes to the light theme.”
Edit & Improve
Annotate and redact screenshots
Highlight the relevant action and remove sensitive information from the image used in your guide.
Crop, annotate and save a screenshotExample with sample data
Example with sample data: the screenshot editor uses the current component and a fictional sample image. Numbered callouts explain the tools. No screenshot was saved to an account.
Choose Crop, Blur, Arrow, Box or Text for the intended change.
Use Undo and Redo to inspect changes before saving.
Save changes, then verify the image in the guide and export.
Select the guide step and choose Edit screenshot.
Choose an annotation tool such as Arrow, Box or Text, then mark the relevant part of the screenshot. Select an existing annotation to adjust its properties.
Use Blur over information that should not appear in the guide. Check the entire screenshot, including headers and background windows.
Choose Save changes, then return to the guide and confirm the edited image appears on the intended step.
Open an exported document before sharing and verify that annotations and redaction are present.
Crop and correct an annotation
Choose Crop (C) and draw or adjust the crop area. Use the crop properties to select Free, 16:9, 4:3 or 1:1 when appropriate.
Switch between Crop preview and Full image to inspect what is included. If an annotation falls outside the crop, use Show full image and move the annotation or adjust the crop.
Use Undo (Ctrl+Z) to reverse an annotation change or Redo (Ctrl+Y) to reapply it. These controls work on changes in the open screenshot editor; they do not restore a whole guide version.
Choose Save changes, then inspect the image in the guide and in your exported document. Cropping changes the guide image; it does not delete the original recording.
Understand redaction scope
Editing a guide screenshot does not mean that the same information has been removed from the original recording or previously downloaded files. Treat the source separately and follow your organisation's data-handling rules.
Important
For highly sensitive content, replace the image or re-record using sample data. Do not rely on automatic detection to find every private detail. Blur is not a guarantee that hidden information cannot be inferred.
Edit & Improve
Append a recording to an existing guide
Extend a guide with another recorded segment, then check how the new steps fit into the workflow.
Select the recording to appendExample with sample data
Example with sample data: select exactly one recording to make Append to guide available. Choose the target guide and insertion options in the next dialog.
Search by name and narrow the status.
Use Filters for project and date options.
Select a capture to reveal Import to projects, Append to guide, Rename and Remove.
Open the target guide and confirm the content you intend to extend. Prepare a short recording of the missing task. Appending creates a new result from the selected guide version; newer results remain in history.
Append a saved capture or video
Choose Append in the editor header.
In Append from capture or video, set Insert after step. Choose Before first step if the new segment should come first.
For a saved recording, choose it under Existing capture → Capture, then choose Append capture.
For a local file, choose Video file under Upload video, then choose Upload and append.
Wait for Append complete. Review the new block of steps at the selected position and check its transition to the surrounding instructions.
Expected result
New generated steps are inserted as one block after the selected step. Existing steps keep their relative order.
Record another segment
In the same Append dialog, choose Open recorder under Record more. Complete the extension recording and its submission flow with the intended project and insertion point. Return to the guide to verify the appended result.
Remove an appended segment
Open Source in the right panel, then Segments, and inspect the recording segment. Where Remove appended steps is enabled, review the segment label and affected steps in the confirmation before confirming. A disabled removal action may mean the source relationship cannot be verified.
Important
Remove appended steps changes the guide. It is separate from deleting the original recording.
Edit & Improve
Manage languages, versions and history
Check which guide version and language you are editing before making or publishing changes.
Use the Language tabs above the guide to choose which text version you are reading or editing. Choose + Language to open Add language versions. Existing languages and newly generated text need separate accuracy checks.
Tip
A language version changes the guide text. It is different from a saved result or recovery snapshot.
Inspect saved results and snapshots
Open History in the editor’s right panel, then Versions.
Choose Details on a result or restore point and check its title, step count and date.
Use Restore for an earlier AI result or Recover for a saved snapshot only after reviewing the confirmation.
After the action, check the guide contents and active language before publishing.
Review Activity
In History, choose Activity to inspect recent changes and their actor and time. Some entries offer Recover when a matching snapshot is available. Use the dedicated recovery article before replacing guide content.
Edit & Improve
Add and remove guide language versions
Generate another text language, review it and remove a translation you no longer need.
Open the guide editor and wait for current changes to save.
Choose + Language beside the Language tabs.
In Add language versions, select at least one new language. Already available languages cannot be selected again in this dialog.
Choose Generate versions and wait for completion.
Select the new Language tab. Review every translated title, instruction and product label before sharing.
Expected result
The new language becomes a selectable guide text version. Check for any warning beside the language and resolve it before publishing.
Remove a translated text version
Select the translated Language tab you want to remove.
Choose Remove beside the language controls. The source language does not offer this removal control.
Read Remove language version? and verify the named language.
Choose Remove version to confirm, or Cancel to keep it.
Important
This removes the selected translated text version. The confirmation states that source steps and screenshots remain available.
Choose export languages
Open Publish and explicitly select the language versions you want to export. Check each downloaded document; do not assume that the currently selected editor tab decides every export.
Edit & Improve
Restore an AI result or recover a saved snapshot
Inspect guide history and confirm the exact content that will replace the current guide.
Open the guide editor, then History in the right panel and Versions.
Find the AI result or restore point using its label, step count and time.
Choose Details to inspect it before changing the current guide.
Tip
Use History → Activity when you know the change or time you want to investigate. Recover appears only for entries with an associated recovery snapshot.
Restore an earlier AI result
Choose Restore on the intended result. The active result is labelled Current.
Read Reset to the original AI result? and confirm the displayed title, step count and date.
Choose Reset result to replace the current guide content, or Cancel to keep it.
Wait for the refresh, then review the restored guide before editing or publishing.
Important
The confirmation says the current guide is saved as a restore point first. Reset result still replaces the guide content you are currently working on.
Recover a saved snapshot
Choose Recover on a restore point.
Check Recover snapshot and the saved snapshot details.
Choose Recover snapshot to replace the current content, or Cancel.
Check the resulting step sequence, screenshots and language selection.
Expected result
The selected snapshot becomes the current guide content. Review it before publishing.
Understand result deletion
Editors and project administrators may see Delete for eligible inactive AI results. Read Delete result carefully: it permanently removes the chosen AI result and every restore point created from it, while keeping the current guide unchanged. The active result and last remaining result cannot be deleted.
Permission
Result deletion requires Editor or project administrator access. Use recovery to correct content; deleting history is a separate permanent action.