Edit & Improve
Edit and organise guide steps
Turn the generated draft into clear instructions with a useful order and structure.
Last updated 2 min readWritten by iTrustech Apps
Reading preferences
On this page
Before you start
- Sign in with Editor or project administrator access.
- Open a generated guide and wait for any current save or processing action to finish.
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.
- 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.
- 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.
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.”
Was this page helpful?
We keep your answer and comment, never your email or IP address.
Page history2 changes
- Publish Help, landing and application page enhancements (#48)iTrustech Apps
- feat: deliver guide authoring, help centre and workspace improvements (#42)iTrustech Apps