How to Fix Technical Writing

by chromatic

Most technical writing I've read isn't very good. One of the reasons the Head First series works is because applying a little cognitive science to the process of writing forces writers and editors to think from the audience's point of view now and then.

The mini-rant How Not to Teach Database Design uses an existing article to show mistakes common to much technical writing. Even if you don't know or care about databases, read and think about the post if you might someday write documentation, an article, a tutorial, or even a set of instructions in your weblog or a wiki or an e-mail somewhere.

Don't worry; they're not grammatical rules you'll never remember. They're just five tips that will help you craft better prose.