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.
Re: RE : More usage: "Open" or "Access" web addresses
Subject:Re: RE : More usage: "Open" or "Access" web addresses From:"Suzette Leeming" <suzette -dot- leeming -at- gmail -dot- com> To:"Leonard C. Porrello" <Leonard -dot- Porrello -at- soleratec -dot- com> Date:Wed, 19 Mar 2008 13:11:45 -0400
Well said, Leonard!
I'll be able to sleep at night now, knowing that I'm not breaking any
techwriting cardinal rules, by telling my users to "Select the XYZ option".
I may be somewhat lax, but I think the MOST important thing is to decide on
a style and stick with it; consistency is more important.
I always remember a quote I once heard - The exciting thing about standards
is that there's so many to choose from.
Suzette Leeming
Stouffville, Ontario
PS - I always use "Go to www.blahblahblah.com" because I consider a URL to
be an "address", abeit a virtual one.
On 3/19/08, Leonard C. Porrello <Leonard -dot- Porrello -at- soleratec -dot- com> wrote:
>
> Some argue that all language is metaphor. In fact, it's not dificult to
> argue that "click" itself is metaphorical. One doesn't click. The "mouse"
> clicks. To be strictly literal, you'd have to say, "apply pressure to the
> left-most button on the top of the mouse until you hear a 'click', then
> release the button." Of course, this begs the question, "does a tree falling
> in a forest make a noise if there is no one to hear it?" In other words,
> "does the mouse really 'click', or is the 'click' merely just a human mental
> construct?"
>
> I don't want to try to settle this issue here. Rather, as a result of
> these considerations, I would suggest there is a continuum between literal
> and metaphorical. While statements that appear to be most literal refer to
> physical acts (e.g., "click"), virtual acts (e.g., opening a combo box in
> a dialog) and mental acts (e.g., reading "words" on a screen) can also be
> considered similarly literal. Therefore, it's not untoward to say "select"
> when instructing a user to choose one of several options, and it's ok to
> tell a user to "go to" a URL. In online help, "Click wwwDOTsampleurlDOTcom"
> and "Go to wwwDOTsampleurlDOTcom" are both fine. In printed docs, however,
> it wouldn't make sense to say, "Click wwwDOTsampleurlDOTcom", and there is
> nothing wrong with saying "Go to wwwDOTsampleurlDOTcom" rather than the more
> literal, "Enter wwwDOTsampleurlDOTcom into the address field of your
> internet browser."
>
> Above and beyond philological and philosophical considerations, one needs
> to consider audience. I totally agree with Ned. What you say depends "on who
> your users are. Find out who needs to do it, and that will tell you a lot
> about whether to give them the baby talk (go to) or the rich heritage
> version (ftp to, or connect to)."
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-