Become a contributor for the Omniconvert blog

1. Title
2. Summary
3. Introduction
4. What You Will Learn
5. Prerequisites
6. “The Meat”
   a. For Tutorials: Steps 1 – n
   b. For Tour: Examples 1 – n
7. Conclusion
8. More resources

1. Title – Why one strong title can change your life

The title is the first thing someone will see about your post. You want to make it:

• The right length: between 8-15 words
• Compelling: indicate to the reader what they’re going to get out of the post in the headline
• Accurate: use specific, concrete language to describe what’s in your post

2. Summary – What is this?

The summary gives the reader a little bit more info on what they can expect from the post. It should be short – try to keep it under 280 characters – the length that could fit in a Tweet.

3. Introduction – Explain the pain

The introduction sets the stage and context for your post. A good introduction will set the stage for a reader. What are we talking about? When does this apply? Why do we even have a problem?

• Explain the pain
• Explain what “old-timers” did before this existed
• Close with 1 paragraph explaining what we’re doing here
• 2-8 paragraphs long

4. What You Will Learn

This short section should directly tell the reader what they will learn by reading this post. Keep it factual and use bullets if you need them. Limit the length to 1
paragraph (or maybe 2).

5. Prerequisites – What you need to know

Use the prerequisites section to link to 2-4 URLs that come just before your article in the user’s “journey”.

Include those prereqs as URLs and, if necessary, give a sentence on each one. When possible, link to resources within \newline – this way the community’s knowledge can build upon each other.

6.a. For a Tutorial: Steps 1 through n

These sections are where you will walk through the tutorial and explain every step to the reader. It’s the meat of the article.

💡 Tip: Default to Detail

Explaining things in detail takes a lot of time to write. As the author, it can
sometimes feel excruciating to spell out every detail.

You’ll know you’re doing it right when you ask yourself, “Is this too much detail? Am I going too slow?”

This level of detail is valuable to readers. If someone is reading the post and they understand what you’re saying, they can skim ahead. But if you skip things then someone who doesn’t understand can’t fill in the blanks.

It’s better to write about fewer topics in detail than to cover a ton of different topics at a shallow level.

6.b. For a Tour: Examples 1 through n

A tour of features is structured differently than a coding tutorial in that the examples typically don’t build on each other.

7. Conclusion

At the end of your post summarize what you’ve talked about. Remind the reader why it’s valuable and what it means for the future. This is also your chance to give a call-to-action!

8. More resources

Close your article by listing resources where someone can go next to learn more. If you used any other sources in your research, give credit and link to them. Give the reader clear steps for where they can learn more.