Learn how to add text and photos, and edit bullets to make your step-by-step guide a complete documentation experience.
Images are an incredibly important aspect of a guide that will set your documentation apart from others out there. Use the Media Manager to add the desired image(s) to each step. Each step may have up to three images.
Adding a Title ¶
The "Add a Title" field allows you to give each step a unique title. Choose a title that will help users understand what will be explained to them in this step. This field is located directly above the images when editing a step. Simply click on "Add a Title" and type in the desired step title.
Guide bullets are customizable icons that make your steps easy to follow. By default the bullets in a guide will appear black, but you can change their color or shape by clicking on them while editing a guide step.
Colored Bullets ¶
If you have added any markers to an image, and a particular bullet corresponds to a marker on the image, change the bullet color to match that marker.
Caution, Note, and Reminder Bullets ¶
In addition to colored bullets, there are also special icon bullets—each with its own purpose.
- Use a caution bullet whenever someone attempting the procedure may injure themselves or damage their equipment.
- Note bullets are useful bits of information that complement the instructions.
- The reminder bullet is used to provide information for after the procedure is completed, such as tips for reassembly.
View our step by step guide that explains how to format and use bullet points within a guide step.
Adding and Editing Steps ¶
Steps are the building blocks for a solid set of documentation. The Guide Creator makes adding and editing steps easy and efficient.
Adding Guide Steps ¶
There are two ways to add a new step to a guide.
To add a step to the end of a guide, click the "+ Add Step" button on the right side of the Guide Creator.
To add a step immediately after the one you are currently working on, click "+ Insert Step" under the bullets in the Guide Creator.
Editing Guide Steps ¶
To edit a Guide Step, click the "Edit" button at the top right corner of the guide. This will direct you to the Guide Introduction edit page. From the list of guide steps on the right side of the page, select the step you wish to edit. You can also edit a specific step by viewing a guide and selecting "Edit" to the right of the step title.
Simply click the text for the particular bullet that you would like to edit, and type in the information you wish to add. Once you are done editing a step, click "Save" to save your changes.
Edit Step Icons ¶
When editing a bullet on a Guide Step, you'll see four icons below the bullet you are editing: a left arrow, a right arrow, a plus sign, and an X. The arrows shift a bullet left or right, allowing you to indent certain lines; the plus sign adds a bullet below the one you're working on; and the X deletes the bullet you are working on. You cannot delete the only line of a guide step. Instead, you must select "delete step."
Deleting Guide Steps ¶
To delete a guide step, edit that step and select the "Delete Step" button in the lower left corner.
Rearranging Guide Steps ¶
From any page in the Guide Creator, click "Rearrange Steps" above the list of steps in the guide. Then click-hold and drag the thumbnail of the step you would like to move to where you want it to be, and click "Save".
Keyboard Shortcuts ¶
You're a busy person. You know what's great for that? Shortcuts. Instead of clicking all those buttons, save time by using these keyboard shortcuts while editing a guide step. All shortcuts can use 'ctrl' or 'alt' interchangeably:
- escape: Stop editing the current bullet
- ctrl+n: Stop editing the current bullet and move to the next one
- ctrl+p: Stop editing the current bullet and move to the previous one
- ctrl+shift+n: Stop editing the current bullet and insert and move to new line below
- ctrl+shift+p: Stop editing the current bullet and insert and move to new line above
- tab: Indent current bullet
- shift + tab: Dedent current bullet
- ctrl+d: Delete current bullet
- Hit Enter to move to the next line, or create a new line if you're at the bottom
- If you hit enter while on an unmodified, fresh line, it'll be removed.
- So, if you're on the last line, you can hit enter twice to stop editing.
- shift-enter: Will behave like enter, but in reverse (going up the list of lines).
When viewing a guide:
- J: Jump to the next step
- K: Jump to the previous step