Amanda Cross 150x150

Many people want to be good writers. It is a central skill because so much of our communication is done through written channels. Everything from technical documents to emails to tweets requires writing.

Unfortunately, some regard writing as an almost mystical process where inspiration flows from your soul onto the paper where it emerges whole, perfect, and sacred. Thinking about writing this way is convenient, because then your crappy writing is the muse’s fault. But it’s more effective to realize that good writing is rarely beautiful at first. Writing is more like making a sculpture out of clay: you start with a big pile of mucky dirt (the first draft) that you have to mash all around (in a text editor) to get it to look like what you want it to look like.

Like the sculptor, the writer must master the tools—-in this case, words. But mastering words is more abstract than mastering sculpting tools, leading some people to think that mastering words must be an in-born talent that can’t be otherwise learned.

Effective use of words can be learned, though, if the aspiring writer is dedicated, disciplined, and willing to make a whole lot of ugly sculptures en route to making a beautiful one. The fact that you created many unrecognizable blobs when learning the medium might not be romantic, but it doesn’t detract from the artfulness of your eventual works of art.

Skill #1: reducing word count

You know the goal of good technical communication is to make the user successful with your product, and your higher-ups probably know that too. But “making the user successful” is hard to measure, and execs like numbers, so chances are, they’re going to be impressed by your page count. Read more…

Amanda Cross 150x150

In the valiant pursuit of providing excellent product help and other documents, just about every technical communicator out there works with subject matter experts (SMEs). Talking to experts is a normal part of the research for writing a technical document. SMEs are an invaluable resource, but can be challenging to work with sometimes. After all, whatever makes them experts in the first place has the potential to also make them:

  • Very busy and hard to get in contact with
  • Frustrated with people who don’t already understand the subject matter
  • Downright arrogant

working together is a matter of habitMy own favorite SME quotes come from back when I was in college. I wrote technical manuals for a high-energy physics lab on campus. Once, after reading my first draft of a document about a piece of machinery in the lab, my supervisor told me, “It’s clear you don’t understand this at all.” That was harsh, but not really rude (and certainly not untrue). It was another time, when a grad student said to me, “I can’t understand why you’re having trouble with this; it’s trivial” that I really got to experience that I’m-too-smart-and-busy-to-bother-with-insects-like-you attitude that some technical writers deal with every day.

Fortunately, there are approaches that you, the technical communicator, can take into your interactions with SMEs to encourage responsiveness and respectfulness, even though you probably don’t have any actual authority over your SMEs.

Prerequisite: be a writer SMEs want to work with

Before you can start pulling the levers of motivating your SMEs, there are a few things you need to do to prepare yourself.
Read more…