wesley tanaka

Writing a tutorial for the web

‹ Just now, a house burned down in the old town | Fixing Camera Shake ›

This page contains my notes on writing tutorials for the internet. I will hopefully revise and improve it over time. Comments are welcome.

Search Engine Friendly

A tutorial is useless if nobody reads it. Ensure that it can be found by searchers by including at least:

  1. What question(s) would someone ask if they were looking for this tutorial?
  2. What symptoms might somebody be experiencing if they were having the problem addressed by this tutorial?
  3. The words "how to", "howto", "tutorial"

Short Attention Span

Internet users frequently have short attention spans. Start your tutorial with a short description of why they might want to read it.

Suggested Sections

Based on the above, I currently include:

  1. 1-sentence description of the tutorial
  2. symptoms that you might be experiencing and questions you might be asking

Suggested Links

Syndicate content