Writing introductions in technical tutorials | James' Coffee Blog
jamesg.blog
When I am writing an introduction to a technical guide, I usually follow a format like this:
  1. Introduce the main concept being discussed in an article, with relevant background.
  2. Reference an example to which I will refer later in the post (optional, depending on the length of the background in the opening paragraph(s)).
  3. Summarise, in a few points, what will be discussed in the article.
  4. Show an example of what someone will accomplish by the end of the article, if possible (most relevant for visual guides such as those that pertain to web design, image editing, computer vision, etc.).
  5. Conclude with a welcoming sentence that eases the reader into the main content.