This blog is a random collection of information, partly in support of my quotations web site. Other topics include wine, military news, economics, history, libertarianism, and other random things which happen to strike my fancy. Backup site is at http://quotulatiousness.blogspot.com/ (if there are no posts showing, hit the backup blog for explanation). Comments have been turned off, as the spam was getting too much to handle. Comments can be emailed to me for posting.

November 15, 2004

Tech Writing and Constitutions

Lady Liberty tries to assemble something from the instructions:

If you've ever bought toys for a kid or some of that inexpensive pressed-wood furniture, you know exactly what the problem is with "some assembly required" goods. It's not that it's safer to ship delicate parts and pieces unassembled in in their own protective styrofoam cocoons. It's not that bookshelves take up far less room in the box when the component boards can all lay flat against one another. No, the problem typically lies with the instructions intended to help you through that "some assembly" that's required of you.

I'm not a stupid woman. I can handle simple tools such as hammers and screwdrivers with ease. I think I speak and understand the English language with some fluency. But when I see a sheet of instructions flutter out of a box of whatever it is I've purchased, I positively cringe. In far too many of my own experiences, the instructions appear to be put together by someone for whom English is not a first language and not a particularly fluent second language, either. And the translations all too often strike me as having been written by engineers in the first place. In other words, they're hopelessly — needlessly! — complicated, and the confusion is only multiplied when there's some question as to the sensibility of the words themselves.

I'm sure almost all of us have had similar experiences! In fact, some of us even cause 'em

Back at the office, I stared at an instruction sheet the manufacturer had kindly blown up to poster size. I caught glimpses of "insert anchor post (part 19) firm into base taking care to be frontward facing (part 2) until snap together is solid (caution to be careful post does not break)" and "refer fig. 17a on reverse" and I shuddered. Why does something that could be so simple have to be made so needlessly complex? Hours could be saved; frustration could be minimized. And if the instructions were simple and easily understood, the product would almost certainly work as advertised the first time you finish building it.

It wouldn't surprise me in the least that many of these assembly instructions are written by exactly the same kind of people who author legislation or government regulations. By trying to address specifically every possible contingency, the verbiage is almost always overly complex. Debate and compromise doesn't lead to consensus but rather to added layers of nuance (. . .not permitted under statute except when capitulated under conditions as described in part 17, paragraph 4 and within the parameters further defined under the itemizations of attachment D which is in effect for the first 120 days of the transition to . . .)

Sometimes, it's just bad writing. Sometimes it's written that way because the company is trying to cover off all sorts of issues in the shortest possible way. Sometimes, they're trying desperately to hide something (like the product not actually working the way it's supposed to).

Posted by Nicholas at November 15, 2004 11:06 AM
Comments
I think the blogulaciousness link you're looking for might be this one. Posted by: Jon at November 15, 2004 01:55 PM
The one I thought I remembered was something like "I have a patent on the phrase 'Click OK to continue", but clearly I'm losing my memory, and it must have been a posting somewhere else. Posted by: Nicholas at November 15, 2004 02:12 PM
I am technically inclined, I frequently can assemble things without looking at the instructions. But on a couple of occasions, the instructions and even the product are WRONG. Frustration is far to mild a work to descibe the pain the this can bring. I won't soon forget the angle bracket on for the fence on Nicholas's tablesaw. It wasn't machined correctly. We must have spent half an hour tring to figure out how it went together before we realized it was wrong. Then another hour and a half fixing it, wiht a dremel tool. I have had similar experiences with products from a large Swedish firm that makes ready to assemble furniture. But the most common problem there, is that the instructions are for a differnt version of the product than the one I am assembling. Like put tab "a" in slot "b". What tab? What slot? there is just two holes, ah and a spare bolt. Hmmm. My favourite instructions to complain about are for Linux. Let me explain. Have you ever heard of GNU. GNU stands for "GNU's not Unix". Well that is a perfect example of the instructions and man pages for most Linux applications. Unless you know how to use the application you can't understand the instructions. Of course if you understood the application you wouldn't need the instructions. Posted by: Clive Tonge at November 17, 2004 07:02 PM
Although I work in the software industry, I have some sympathy for the writers who try to document hardware: the writers are almost always the last ones to find out that something has changed in the manufacturing process, which often means that the document is correct for "what used to be in the package" instead of "what's now in the package". Of course, this doesn't excuse manufacturers who don't hire writers to produce quality documentation: after all, any idiot can write, right? Posted by: Nicholas at November 18, 2004 11:02 AM


Visitors since 17 August, 2004