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—and will set your documentation apart from others out there. Use the Image Uploader and then drag the desired image(s) into each step. Each step may have up to three images. Rearrange your photos by editing the step and then dragging them into correct order.
Guide bullets are customizable icons that will make your guide easy for others to follow. By default, the standard bullets in a guide appear black. Change their color by simply clicking on the bullet while editing a guide step.
Colored Bullets ¶
If you have added any markers to an image, and a particular bullet corresponds to that marked-up image, you should change the bullet color to match that of the 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.
- Notes are useful bits of information that complement the instructions.
- The push pin reminder bullet is used to provide information for after the procedure is completed, such as tips for reassembly.
Make Title ¶
The "Make Title" icon is more than just a bullet, and will only appear as an option for the first bullet in a step. Selecting this icon will remove the first bullet from the step text, and replace the default step title with the bullet text.
Adding and Editing Steps ¶
A step-by-step guide is nothing without steps. The guide creator makes adding and editing steps fast and efficient.
Adding Guide Steps ¶
There are many ways to add a new step to a guide. Add a step to the end of a guide with the "add step" button on the right side of the guide creator.
Additionally, when editing any step in a guide, you may click "Insert Step" to add a step immediately after the one you are currently working on.
Editing Guide Steps ¶
To edit a guide step, you may click the "Edit" button at the top right of the guide; this will take you to the guide introduction edit page. From the list of guide steps on the right, select the step you wish to edit. Alternatively, you may find the specific step while viewing a guide and select "Edit" to the right of the step title.
Simply click the text for a particular bullet that you would like to edit. Once you are done editing a step, click "Save" to save your changes.
Edit Step Icons ¶
When editing 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 another bullet below the one you're working on; and the X deletes the selected bullet. You cannot delete the last line of a guide step. Instead, you must select "delete step."
Deleting Guide Steps ¶
To delete a guide step, edit that step and select "delete step" above the bullets.
Rearranging Guide Steps ¶
From any guide edit page, you may click-hold and drag a step from the "Guide Steps" tab on the right of the Guide to change the step order.
You're a busy person. You know what's great for that? Shortcuts. Instead of pressing all those buttons, save some time by using these keyboard shortcuts while editing a guide step. All shortcuts can use 'ctrl' or 'alt' interchangeably
- escape: render current
- ctrl+n: render current, move to next
- ctrl+p: render current, move to previous
- ctrl+shift+n: render current, insert and move to new line below
- ctrl+shift+p: render current, insert and move to new line above
- tab: indent current
- shift + tab: dedent current
- ctrl+d: delete current
- 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).
Your vote has been recorded.
Tell us more. (optional)