Writing great step-by-step guides

Guidelines are great for explaining procedures that would otherwise require human resources and interaction.
Updated: 17.11.2016 17:36

Write a great title for your guide

Guides should be action-oriented.
Starting your guide with a verb or a "How to" makes it easy for the user to understand the content of the guide.
Keep your title concise
Examples are:
"How to.."
"Creating.."
"Deleting.."

Write a great subtitle

A good practice for writing subtitles is writing a short sentence about "Why" and/or "When" you should follow this guide.

Write great steps

Try to imagine that you are the target for the guideline and that you are a complete novice.
Write text that explains the procedure stepwise, making sure not to miss any step.
You should take care not to lose the reader as you proceed.
Keep the text as short as possible. In many cases it may be better to add an extra step than to have a lot of text in one step.
In many cases it may be better to add an extra step than to have a lot of text in one step.

Use great pictures and illustrations

A picture says more than a thousand words and will make your guides more comprehensible. Just don't overdo it

Organize big guides in chapters

Generally, a guide should focus on what the headline is indicating.
However, sometimes it may require the reader to perform several sub tasks to reach the goal.
Organize your guide in chapters.