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: How much do people need to be told in documentation.
Subject:RE: How much do people need to be told in documentation. From:"Tommy Green" <tom -dot- green -at- iwon -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 17 Sep 2001 11:31:57 -0500
-- Original Message --
>
>Two issues. I'm documenting a script where the person using the
>script must fill in a form and some of the form fields require an
>email adddress. He insists on including a full paragraph on what a
>valid email address looks like.
>
>>
>Opinions on either?
>
I agree with you on both topics John. If someone does not know how to fill
out their email address, they probably don't own a computer anyway. I believe,
unless your audience is grade 6 level or below, that everyone knows what
an email address is.
As to the CTRL-C and CTRL-V...other manuals state it the way you want to.
If the user knows the other ways, then fine, he/she will use whatever is
comfortable for them. No need to list all the different was to do it.
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
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.