Categories
Documentation Language Writing

A Deep Dive into Technical Writing

As a writer – albeit these past 30 some years of technical topics – I believe words actually do have meaning and should be used carefully and correctly. So when I read recently in a LinkedIn post that a product manager had a “deep understanding” of his industry; or a post from my neighborhood email blast that a neighbor was looking to have someone do a “deep clean” of her house; or finally, that a webinar promised a “deep dive” into a topic; I knew something was amiss.

What’s up with all of these deep activities?

Why suddenly is an understanding of an industry insufficient that it now requires the adjective deep to make it somehow better? How does a cleaning of a house become more thorough by making it a deep cleaning? And a deep dive? Unless you’re discussing a scuba dive, what are you talking about?

The obvious answer, of course, is that corporate speak is to blame. People seem to need to misuse words to somehow make their lives more meaningful. Or something like that.

In technical writing, on the other hand, there is no “deep dive”. Or to put it another way, if you don’t know – don’t have a true understanding – of the technology you’re writing about, you’re wasting your time and, more importantly, the time of the poor person reading your useless work.

Because all good technical writing is a “deep dive”. To do less than that is not technical writing, it’s wordsmithing. And that is the biggest insult you can possibly hurl at a technical writer.

Categories
Blogroll Business Captivate Flare Humor? Language Marketing Networking Rants Uncategorized Water Cooler Stuff Writing

Corporate Speak: Between Sweet Spot and Wheel House

These days, business speak surrounds us. It doesn’t discriminate against company size or position status. College interns and CEOs alike find themselves dropping buzz words in conversation. But to what end? When is enough, enough? The next time you want to move forward, deliver, or buy-in by all means go for it. But don’t expect people to know what you’re talking about. The more time your employees spend guessing the meaning behind your jargon, the less productive they are. Ben Franklin sums it up best:  “Time is money.”

Categories
Business Captivate E-mail Language Rants Tools Uncategorized Writing

What’s Wrong with the Passive Voice?

Why do people use the passive voice? Engineers, scholars and business people alike use the passive voice on a daily basis – probably without even realizing it. So then, why is passive voice frowned upon and what exactly is it?

Simply put, passive voice is a style of writing that makes the object of the sentence the subject of the sentence. Sentences written in passive voice are structured so that the noun who performs the action is not the subject. Confused? Consider this illustration.

Sentence 1: I made a mistake (Active)
Sentence 2: Mistakes were made. (Passive)

Categories
Useful Links Writing

Use Your Words!

Precise word choices are one of the hallmarks of a great technical writer. Even if you don’t have much difficulty picking the right words and phrases when expressing your own thoughts, I’m sure you’ve encountered a situation where you ran into problems interpreting a client or SME’s writing/requests/emails. Here’s some links to some of the handy reference tools that I sometimes use to help me interpret a client’s requests or find the perfect word or phrase. Hopefully these will make a difference in your writing in 2011!