--- title: "Editing a Step by step guide" slug: "editing-a-step-by-step-guide" description: "Refine your guide with our step-by-step editor: edit titles, descriptions, images, and add visual enhancements for a polished final product." status: "update" updated: 2026-09-04T11:13:11Z published: 2026-09-04T11:13:11Z canonical: "docs.document360.com/editing-a-step-by-step-guide" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # Editing a Step by step guide Once your recording is uploaded, the Step by step guide editor opens in the Knowledge base portal. Each step is automatically generated based on the captured workflow, with the step title and description pre-filled from the recorded actions. Each step displays the captured screen on the left and a right-side pane with editing options. This article covers everything you can do to refine and enhance your guide before publishing. --- ## Edit step content The right pane lets you adjust the core content of each step: 1. **Title** - Enter the step title. To add a hyperlink to the title, select the text and click the **Hyperlink** icon. 2. **Description** - Add instructions or context for the step. Use the rich text toolbar to format with Bold, Italic, Underline, ordered list, unordered list, or Hyperlink. 3. **Slide image** - Click **Replace image** to swap the captured screenshot. Choose from one of these sources: NOTE The supported formats are JPG and PNG, with a maximum file size of 10 MB, a recommended resolution of 1920×768, and a minimum of 100×100. - **Select from original** - Pick a frame from the recorded video. Use **Select exact frame** for more precision, or use the **Jump to** dropdown to navigate to a specific click in the recording. - **My drive** - Click **Upload** to choose a file from your local explorer. - **Background** - Pick an image from available background images. 4. Click **Insert** to apply. NOTE The images used in each step are derived from your recorded session. You can choose any frame from the original recording to create a new step or replace an existing image. --- ## Insert a new step To insert a new step: 1. Hover between any two existing steps until the **Add step (+)** icon appears. 2. Click the **Add step (+)** icon. 3. In the right pane, update the default title - "This is a sample title". 4. Add a description for the step. Use the rich text toolbar to format with Bold, Italic, Underline, ordered list, unordered list, or Hyperlink. 5. Click **Add Image/Background** to set the step image. Choose from one of these sources: - **Select from original** - Pick a frame from the recorded video. Use **Select exact frame** for more precision, or use the **Jump to** dropdown to navigate to a specific click in the recording. - **My drive** - Click **Upload** to choose a file from your local explorer. - **Background** - Pick an image from available background images. 6. Click **Insert** to apply. --- ## Add a new chapter Chapters group related steps into named sections, so a long guide reads as a few distinct phases rather than one flat list of steps. Readers see the chapter titles in the guide navigation and can jump straight to the part they need. Use chapters when a guide covers more than one stage of a workflow. For example, setup, configuration, and verification. For a full walkthrough on creating, renaming, and deleting chapters, see [Creating and managing chapters](/help/docs/managing-chapters). --- ## Add visual enhancements These tools overlay visual enhancements directly onto the step image to make every step clearer and more reader-friendly. - [**Blur**](/help/docs/blur-md) - Hide sensitive or private information such as passwords, {{ glossary.API}} keys, or customer data directly on a step image. - [**Image**](/help/docs/image-1) - Overlay an additional image onto a step, useful for adding diagrams, icon keys, or branded assets alongside your screenshot. - [**Spotlight**](/help/docs/spotlight-1) - Dim everything around a specific area to draw readers' attention to exactly where it needs to be. - [**Text**](/help/docs/text-1) - Add custom annotations over a step image to call out something that isn't visible in the UI itself. - [**Highlight**](/help/docs/highlight-1) - Mark important areas with a colored overlay without dimming the rest of the screen. --- ## Slide behaviour ### Zoom in effect Apply a zoom-in effect to draw attention to hotspots or key areas within the step image. Use this to focus the reader on a small or easily missed element — a checkbox, a toggle, a link — without cropping out surrounding context. #### Enable Zoom in effect 1. Select the desired step. 2. In the right pane, go to **Slide behaviour**. 3. Enable **Zoom in effect**. 4. Once enabled, **Zoom in (+)** and **Zoom out (-)** options appear on the top-right of the step. #### End user experience - When the zoom-in effect is enabled, the slide image is automatically zoomed in on first view. - Readers can click the **− (zoom out)** icon to return to the original view. - They can use the **+ (zoom in)** icon to zoom in again as needed. --- ### Animate click Instead of a static image, animate a step by playing a short video clip around the recorded click. Useful when the result of a click is a dropdown opening or a panel expanding - is important for the reader to see. #### Enable Animate click 1. Select the desired step. 2. In the right pane, go to **Slide behaviour**. 3. Enable **Animate click**. 4. From the **Animation duration** dropdown, select a duration: - **3 seconds** - Shows 1.5 seconds before and after the click. Best for fast, simple interactions. - **5 seconds** - Balanced; good for most cases where a brief animation is needed. - **10 seconds** - Shows up to 5 seconds on each side; best for slower transitions like page loads or animated UI responses. Duration adjusts based on available footage. #### End user experience The step plays as a mini video, centered on the click point. --- ## Edit step image ### Crop Use **Crop** to trim away distracting browser chrome, sidebars, or irrelevant screen areas and keep the reader's attention on what actually matters in that step. For a full walkthrough on how to crop a step image, see [Crop](/help/docs/crop-1). --- ## Managing added elements To review and manage all enhancements added to a step: 1. Expand the **Added elements** section in the right pane. 2. Hover over any element to access available options: - Click **Edit** to update it. - Click **Delete** to remove it. ![Instructions to click the 'Browse articles' button for accessing support articles.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/sbs%20final%20edits.png) --- ## Configure the guide title, description, and SEO Every Step by step guide has its own settings panel for the metadata that search engines and AI agents read. The description you set here appears in search engine snippets and in your knowledge base's `llms.txt` file. To configure the title, slug, and description for a guide, 1. Navigate to the guide in the Knowledge base portal. 2. Click the **More** (•••) icon and select **GEO/SEO**. The **Article settings** panel appears. 3. Update the meta title and slug. 4. Select the **AI & search descriptions (GEO/SEO)** tab. 5. Enter a description in the **Description** field, or click **Ask Eddy AI** to generate one. 6. Click **Save**. NOTE Step by step guides are structured for AI agents and LLMs to read. A published guide is served as a Markdown (`.md`) page and listed in your [llms.txt](/help/docs/llms-txt) file, so a guide without a description is listed by title only. For guidance on writing descriptions, read the article on [Article GEO/SEO](/help/docs/article-seo). --- ## Next steps Once your guide is polished, you can publish, translate, clone, or manage access. See [Managing step by step guides](/help/docs/managing-step-by-step-guides) for translation, cloning, unpublishing, and settings. ## FAQ **How do I configure the SEO title and description for a Step by step guide?** Click the **More** (•••) icon on the guide and select **SEO**. For the full procedure, see [Configure the guide title, description, and SEO](/docs/editing-a-step-by-step-guide#configure-the-guide-title-description-and-seo) in this article. **How do I update the title and URL slug?** Click the guide's title at the top of the editor > update the **Title**, **URL slug**, and **Description** > click **Update**. **How can I enable the Table of Contents for my Step by step guide?** Each step in a guide can appear as part of a Table of Contents on the Knowledge base site. To enable the Table of Contents: 1. Navigate to **Settings** () > **Knowledge base portal** > **Article settings** in the Knowledge base portal. 2. Expand the **Article right section** accordion. 3. Turn on the **Show table of contents** toggle. **Will my guide appear in `llms.txt` if I do not add a description?** Yes, but by title only. The description is what tells an AI crawler whether to retrieve the guide, so add one for every published guide. ## Related - [Creating and recording Step by step guides](/creating-and-recording-step-by-step-guides.md) - [LLMs.txt](/llms-txt.md)