Writing introductions in technical tutorials | James' Coffee Blog
jamesg.blog
external-link
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.

huh, sounds helpful (i should be writing)

alex [they, il]
creator
link
fedilink
31Y

good luck! I believe in you!

Create a post

A nice place to discuss rumors, happenings, innovations, and challenges in the technology sphere. We also welcome discussions on the intersections of technology and society. If it’s technological news or discussion of technology, it probably belongs here.

Remember the overriding ethos on Beehaw: Be(e) Nice. Each user you encounter here is a person, and should be treated with kindness (even if they’re wrong, or use a Linux distro you don’t like). Personal attacks will not be tolerated.

Subcommunities on Beehaw:


This community’s icon was made by Aaron Schneider, under the CC-BY-NC-SA 4.0 license.

  • 1 user online
  • 144 users / day
  • 275 users / week
  • 709 users / month
  • 2.87K users / 6 months
  • 1 subscriber
  • 3.09K Posts
  • 64.9K Comments
  • Modlog