After many years of blogging, and consistent with my desire to move toward retirement, we have ended the Insights blog. Thanks to Doug Bedell for his years of blog support.

Ready, Write, Aim – No, That’s Not It

Posted on April 8, 2016
Filed Under Communication, The Writing Life | Leave a Comment

images
What’s the most important element in starting a technical writing task? (Or any other, for that matter.) Why, it’s your aim, of course. “What am I trying to accomplish with this? Where are we headed?” Putting first things first requires that you have a good fix on what you’re aiming for before you start doing it.

Don’t be the kind of writer who just tries to fill space – that won’t have a worthwhile outcome. We used to do editorial writing, with a wide column of empty space to be filled daily. But filling that space wasn’t, or shouldn’t have been, our aim. Having something to say was what benefitted readers, sharpened their perceptions and expectations of us. That was, or should have been, our real aim.

Such thoughts occurred (again) while reading Neal Caplan’s post “…You’re Not Good Enough.” Being judged by other people’s standards is okay, so long as you all have the same aim. But if you don’t, watch out. You may get to where they’re headed and find, pretty quickly, that it’s not where you need to be. It’s all in your aim.

Taking careful aim shouldn’t be any different for technical writers than anyone else. What in the way of writing crisp, efficient documentation should be your intent on behalf of those who will be using it? Don’t just start spieling out directions. They may get pretty roundabout.

“As nice as it is to hold a copy of a book that you wrote,” Neal notes, “it’s not so nice to tell your customers that they MUST read that book before they can use your product. Or, more likely, that shelf full of books. This is the opposite of ‘just in time’ help: it’s ‘become an expert on this product before you ever think about touching the UI.’”

Your aim isn’t to help colleagues become expert at what you’re doing, but to become better at what they’re trying to accomplish. There’s always more to discover, learn and know. The real question is: to what end? What are you aiming for, organizationally and individually? Keep focused on that; it’s what matters most. – Doug Bedell

Comments

Leave a Comment

If you would like to make a comment, please fill out the form below.

Name (required)

Email (required)

Website

Comments

Email Subscribe

Recently


Categories


Archives


Blogroll