Building help topics around your screen captures


Building help topics around your screen captures

Building a help topic around your images is as easy as adding simple text and instructions - so the reader can complete the task as easily as possible.

See also: Creating your first help topic

Adding sub-titles (new steps)

Breaking your topic up into small steps is the best way to create help that is easy to follow. Add sub-titles when you want to create a visual cue to the user that a new step is starting. Click the add title button (1) on the add element toolbar to add a new sub-title.

Adding rich-text (instructions)

Add rich-text to each step to explain what the user needs to do. Be as clear and concise as possible and try to keep your words to a minimum. Use the add text box button (2) to add a rich text box.

TIP: Adding annotations to images is a great way to cut down on the amount of text you need to write, remember, a good picture is worth a thousand words.

Adding links

You should add links to related resources whenever it will help your users to understand a or complete a task or simply for further information that may interest them. See the section on adding links for a quick step-by-step guide.

Adding images

You can add images and screen-captures anytime, there is no limit to the number you can add but it is a good idea to keep your help topics short so they are quick to scan and complete for your users. Adding annotations to images is a great way to cut down on the amount of text you need to write.