It's Quick, Its Easy, Its Simple Was: Re: Ikea method of technical writing (graphical instructions)

[Chris Borokowski]

Yes. That's the origin of your writing teacher admonishing you to "Show
not tell." If it's simple, the instructions will show it. No need to
mention that it is simple. As in life, symbols should demonstrate
reality and not replace it.

The worst TWing is the use of "simply." It is easy to slip into and I
am not seeking vengeance upon those who have done it, but I would like
it to stop. "To configure the nuclear reactor, simply shut down tubes
3-19 as you recorrelate the traction rods with immersive cooling bath
while measuring proton deflection frequency at the tower."

If I wanted to show how simple it was, I would've made that a bullet
list with an Ikea-style drawing of a radiation victim next to it.

--- Richard Lewis <tech44writer at yahoo.com> wrote:

>   Have you ever noticed that often really bad TWing begins like this:
>  "The procedure to do this is simple...."    Logic of writing such:
> Thinking that the end-user will be so condemning themselves for being
> stupid that they will never realize how badly the instructions are
> written.   Te he he, neat trick - great  way to solve a tough
> usability problem!


http://technical-writing.dionysius.com/
technical writing | consulting | development


       
____________________________________________________________________________________
Yahoo! oneSearch: Finally, mobile search 
that gives answers, not web links. 
http://mobile.yahoo.com/mobileweb/onesearch?refer=1ONXIC