Getting Started With Guides

Overview ¶ 

Guides are great, easy-to-use tools that allow you to illustrate technical procedures to almost any audience. Our guides have been used for everything from replacing the logic board on an iPad Mini to assembling a drivetrain. This overview gets you started with the features and benefits of using the guide platform.

The foundation for any good manual is clear and effective step-by-step documentation that is easy to follow—and easy to develop. Our guide creator makes it incredibly easy to write, edit, and publish guides. To start a new guide, just select your desired category, or select 'Guide' on the New Page tool.

Block Image

Guide Introduction ¶ 

Block Image

The "Guide Introduction" tab is the first place you are taken to when editing a guide. Its purpose is to help users become acquainted with your procedure.

You have the option to provide background information and add or remove flags to your guides from here.

Details ¶ 

Block Image

The "Details" tab is where you can provide essential information to a guide. List everything from parts, tools, difficulty, and required time—ensuring greater success for your end-users. You can also add prerequisite steps onto the guide. Access Details by clicking the middle tab at the top of the Edit page.

Guide Steps ¶ 

Block Image

The "Guide Steps" tab is where you create the unique steps for any guide. Add images and markers to make your guide as engaging as it is informative. Use explanatory text, bullets, notes, and mark-up to make the guide as clear as possible.

Go back to the Help Index

Was this article helpful to you?
Yes
No
Didn't find the answer you were looking for? Ask a Question