David Barnes @ Packt

writing computer books that people want to buy 
Tags


Filed under

introduction

 
June 8, 2009

Give Your Tutorial a Killer Introduction

Your tutorial needs an introduction. The point of the introduction is to tell the reader what they'll learn in the tutorial, get them juiced up about it, and help them to prepare their minds for what's ahead.

An introduction in a technical tutorial should not introduce anything technical. It is an introduction to the tutorial itself, not to the technology you are discussing.

The introduction to a tutorial should have the following parts:

  1. Context: A sentence that reminds the reader where they are already, and perhaps why they need to learn more. For example: "In the last chapter we saw how to store information in the computer's memory using variables."
  2. Outcome: What's the reader going to accomplish in the chapter? What will the chapter do for them? What's the theme? State it in one chapter, using the most jargon-free language you can: "In this chapter, you'll see how to use information in the computer's memory to make various decisions, and affect what your program does."
  3. How we'll get there: Now break down the task into its main stages or sections. Usually you'll do this with a bullet list -- one for each major section or stage in the chapter. One of the bullets in this chapter might be: "Use different kinds of loops to get the computer doing the same thing over and over again until a certain condition is met, or the loops gone around enough times." You'll need to introduce this list with a sentence such as "We will do this by:" or "Specifically you will learn how to:"
  4. Restate outcome: After the list, restate the outcome in a different way. Something like: "By the end of this chapter, you'll have no problem using these techniques to control the logic in your programs".
  5. Restate context: The introduction starts by telling the reader where they are now, and why they need to learn more. Finish the introduction by telling them where they will be by the end... how will their world be better: "Once you've mastered this, you'll be able to write some entertaining interactive programs, and will be ready to move onto more advanced programming topics."
  6. Finally, move onto the content: End the introduction with something that moves the reader into the main content of the chapter: "So without further ado, let's get started."
Whether you're writing a chapter in a book or a tutorial for your blog, an online site such as NetTuts+, or any other source, this introduction format will get your writing off to a strong start... and get your readers keen to carry on and learn what you have to teach them.

Loading mentions Retweet
Filed under  //   introduction   writing  

Comments [1]