Writing Is Hard. That’s Why So Few People Do It Goodly.

If you’re trying to communicate with customers, support the users of your products, or just share important knowledge with other humans — you’ll probably end up needing some words in a row. But even though you passed penmanship in third grade, you might consider hiring a pro.
Flowbee

Like fixing your transmission, neutering your dog, and cutting your hair — some tasks are better left to someone with the appropriate background, tools, and perspective.

The server framework goes in, the website framework goes out. The effect is similar, the innermost attributes override the outermost, but the difference is subtle, in the website framework the storage location of the content determines its attributes, in the server framework, the path that got you to the object determines the attributes.

That seems simple enough, right? An old rule says that you shouldn’t use a word when you’re providing a definition of that word. Makes sense.

So what do these “writer” types know that you don’t? Most of it’s simple to say, but a little harder to actually do.

Mr. RogersFirst on the list is learning to write in the correct “voice”. That means sound like a drill instructor if you’re training soldiers, and like Mr. Rogers if you’re teaching kindergarten. Don’t talk down to your audience. Don’t use lots of abbreviations and mystery words.

Second consideration at the Real Good Writers School would be to create a clear outline before you begin. Imagine you’re driving from Seattle to New York. To begin, that’s all you need to know. Next, what Interstates will you be taking? After that, what local roads will take you to hotels, food, and huge plaster dinosaurs? Remember that we all need clear signs of where we’re going, where we are, and where we’ve been.

Third — edit brutally. Writing is easy, cutting is excruciating. But go back and cut out every single word that doesn’t add value. Unless you’re being paid by the word, less is more. Turn prose into bullets. Add an appendix. Use incomplete sentences. Like these. (Well, unless you’re still in the third grade. I don’t want a blemish on your permanent record.)

Vista Capable?Finally — don’t try to impress me with your stunning vocabulary. The use of little, short words eliminates a lot of confusion. Say “fired” not “downsized”. Say “broken” not “limited functionality”. Say “it slipped again” rather than “we’re delaying the release because of our commitment to quality.”

And use the damn spell checker.

{ 4 comments… read them below or add one }

Karen Sopko June 18, 2007 at 6:39 pm

Nice thinking,
I thought I had done some tough writing in proposal land, but when I try writing game rules – a whole new challenge! Our company creates games for the workplace, and I can tell you the game rules we have read leave a lot of room for improvement. Let’s just say the English language can throw some real curve balls at you, when you are talking about games. Words like, round, turn, hand, discard, and deck all have multiple meanings.

Reply

Dick Carlson June 18, 2007 at 8:34 pm

Karen:

Yes, localization often provides some surprises. The use of English (and “American”) words is often full of surprises for non-native speakers.

We’re also now in a time when the “digital natives” speak their own language, many times across geographic boundaries. So the divide moves to a different level — age, income, technical experience — rather than our traditional challenges.

When I interview a Second Life game developer, the new words and concepts fly thick and fast. Conceptually, a world that you create yourself carries with it the likelihood that you will see things differently than your neighbors.

Reply

Howard Gutknecht June 27, 2007 at 11:45 am

Your avatar looks a lot like you. Did you put as much thought into your avatar as you did into this tutorial on good writing? What was your decision process on how your avatar looks?

Reply

Dick Carlson June 27, 2007 at 12:43 pm

Howard:

Yes, although younger and slimmer, TechHerding Kidd does share some of my meat-world appearance. That was intentional.

When I first joined SL, I made my avatar very good looking. (Tall, muscular, high cheekbones.) Then, when I realized that nearly everyone there was good looking, I morphed my avatar into a short/bald/round/mouth-breather. Just to be contrary.

After a while, I decided that it would be interesting to just be me — something that many of the long-timers seem to do, with just a little bit of artistic license. But I still have the settings for the bronzed god in a folder, if I need them again.

Reply

Leave a Comment

« »