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: Is it polite to point web browsers? From:"Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com> To:"'Techwr-l'" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 17 May 2007 08:10:33 +0100
Terms, yes. Generalized, sorry, generalised procedures... Well, I'm starting
to change my mind over this one.
I have done the same in the past, but (and as ever, your audience and
requirements will differ from mine) who actually reads those?
A lot of documentation is largely used by those who are stuck. They want
answers and there is a limit to how many hoops they will jump through to get
them. Admittedly, these days, the fact that they have opened the
documentation at all means they are pretty determined, so yeah maybe they'll
stand to be referred to a 'General Procedures' section, but maybe that extra
leap will be one too far?
Just a thought (and another reason why I love this field so... The constant
flux of 'what ifs' don't half keep you on your toes!)
Gordon
-----Original Message-----
From: techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Chris Borokowski
Sent: 16 May 2007 22:09
To: Techwr-l
Subject: Re: Is it polite to point web browsers?
There's always the option to define terms and generalized procedures at the
beginning of a manual.
At that point, detail can be added to the idea of "going" to a website, but
if it's done each time in the doc... most of them will fall asleep over the
manual :)
--- Julia Norquist <techiejules -at- yahoo -dot- com> wrote:
> Rather than telling them, "Point your browser to
> www.randomaddress.com," I tell them, "Go to www.randomaddress.com."
____________________________________________________________________________
________Yahoo! oneSearch: Finally, mobile search that gives answers, not web
links. http://mobile.yahoo.com/mobileweb/onesearch?refer=1ONXIC
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor, full
Unicode support. Create help files, web-based help and PDF in up to 106
languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as
Gordon -dot- McLean -at- grahamtechnology -dot- com -dot-
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/ for more resources and info.
No virus found in this incoming message.
Checked by AVG Free Edition.
Version: 7.5.467 / Virus Database: 269.7.1/805 - Release Date: 15/05/2007
10:47
No virus found in this outgoing message.
Checked by AVG Free Edition.
Version: 7.5.467 / Virus Database: 269.7.1/807 - Release Date: 16/05/2007
18:05
____________________________________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
____________________________________________________________________________________________________
Graham Technology plc
Registered in Scotland company no. SC143434
Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-