Hacker News new | ask | show | jobs
by MarinaMichaels 1422 days ago
"Writing well" can mean two things: Putting together clear, concise, grammatically correct sentences that are pleasant to read; and organizing your content in a useful, rational way.

Technical writing needs to do both, and it also needs to teach well.

Teaching well doesn't always mean you're writing well, and vice versa.

Teaching well means using what cognitive and learning scientists have discovered about how best to teach adults.

Books like Strunk & White's Elements of Style are good resources for putting together good sentences. Fewer books teach organizing your content, and even fewer teach how to teach well.

1 comments

Lisa Cron's book, _Wired for Story_, is aimed at fiction writers, but any type of writer can benefit from her book. She gives excellent cognitive-science-based reasons for each writing tip she gives.

I'm an editor/book project manager at a major computer book publishing company, and a former software tech writer. I recommend Lisa Cron's book to all my authors.