Improve Your Technical Writing in 3 Steps

In technical writing, aim for clarity, not style. Don’t annoy the reader with useless information that clogs up the user guide and obstructs them from finding the answers they’re seeking. Get to the point. Fast. Here are three ways to do this. Improve Your Technical Writing in 3 Steps Aim for brevity. Be useful. Stay […]

4 Golden Rules of Capitalization in Technical Documents

It is ebay or eBay or Ebay? How Technical Writers use capitalization in user guides creates many problems for editors, reviewers, and users. Part of the problem is a lack of guidelines and style guides. What you think looks fine break some style guide rule you were unaware of. The Capitalization of Microsoft A good […]

21 Words That Make Technical Writers Look Dumb

We both know that a Microsoft Exchange Server doesn’t have feelings, hopes and desires. But when we write technical documents, these type of human feelings can creep in. You need to be careful when writing user guides, design documents, and specifications as these false words give the wrong impression and undermine the quality of your material.

9 Ways To Peer Review Technical Documents

I’ve always had mixed feelings about peer reviews. What they’re done right, we all learn but like Lesson Learned review can easily degenerate into bitching sessions if not managed correctly.

How Stephen King Can Make You a Better Technical Writer

Scott says, “If you want to improve as a writer, you not only need to write. You need to read. Writing and reading are two sides of the same coin. You need to do both to achieve your potential.” I head downtown most weekends and buy 2 or 3 books, mostly business, history and some fiction. Every so often I run out of options (we’re in Beijing) and get something I usually wouldn’t buy, for example, Iain M Banks. Reading outside my comfort zone stretches me. I encounter writing styles, opinions, and information that I usually side-step.

Does your writing have an accent?

Maybe you don’t hear your accent, but others do. When you read their documents, does the accent come through?

Put Your Words on a Diet

Goethe once wrote to a friend, “If I had more time, I’d have sent you a shorter letter.” Here’s why.

How To Mind Your Grammar On The Web

Ben Parr (Mashable) asks: “Say your project manager comes to you with his proposal that will be going out to investors, business partners, and potential clients. Then you find that your manager has used “4” instead of “four”, “r” instead of “are”, and abbreviations such as lol, atm, and idk. How would you react? “