TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: What to do about writing samples From:"Mike O." <obie1121 -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 22 Jan 2003 11:04:46 -0800 (PST)
Well, it's not my argument, I'm just repeating it because it was
relevant, and provides the opportunity to use the "endless loop
in the shower" joke.
But since you asked...
Back when "user interface" meant "MS-Windows," the OK button was
the standard way to end any interaction with a dialog box, so it
was really tempting to leave "Click OK" off the procedures.
Then came tabbed interfaces, with their Apply buttons, and
inconsistent "Save" behaviors. Then it was less clear what you
had to do to make your changes take effect: http://uie.com/tabbed.htm
Now we have creative artists using PhotoShop to invent whole new
"innovative" user interfaces. For the life of me, sometimes I am
totally stumped for a while before I figure out how to complete
the interaction.
But "Click OK" is never the end of the procedure. If you want to
provide docs with depth, you have to explain what happens when
you click OK. By "explain what happens" I don't mean just a
description of what jumps up on the screen, I mean the back end
processing.
--- Jeff Hanvey <jewahe -at- lycos -dot- co -dot- uk> wrote:
> ----- Original Message -----
> From: "Mike O." <obie1121 -at- yahoo -dot- com>
> > Actually it says "Lather, rinse, repeat..." It doesn't say
> when
> > to stop, so theoretically there could be people stuck in an
> > endless loop in showers all over the country. I have heard
> this
> > used as an example of why procedures don't need to include
> > "Click OK."
>
> Perhaps you could explain this argument. I don't see any logic
> behind it at
> all.
>
> But then, I never just write "click OK" without giving the
> users something
> to let them know that the procedure is complete.
>
>
> Jeff Hanvey
> Augusta, GA
> jewahe -at- lycos -dot- co -dot- uk
>
>
__________________________________________________
Do you Yahoo!?
Yahoo! Mail Plus - Powerful. Affordable. Sign up now. http://mailplus.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.
A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.