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: Field-specific Help From:l m <lm5582002 -at- yahoo -dot- com> To:Chris Borokowski <athloi -at- yahoo -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 17 Aug 2007 07:10:55 -0700 (PDT)
Okay, first of all, I'd like to thank everyone who has
responded so far. I think the idea of specifying alpha
v. numeric, hyphenation, etc. is a good one, but as
far as I'm told, there are no
requirements/restrictions on the data that will be
accepted by the system.
Secondly, thank you, Chris, for cracking me up this
early in the morning: "Legal Department?" I'm
ROTFLMAO. I only wish we were that, um, corporate.
And I think that's the main problem: We're a big
company but we don't have the structure that "normal"
companies do, so I feel like I have no resources for
questions like this, and those who are making the
decisions about what goes into the documentation/help
are people who've never written any kind of end-user
product before.
I don't mean to rant; I just feel like I'm being
directed by people who give no thought to the
users/audience to do something that isn't particularly
valuable for the users/audience. So I'm trying to
figure out how to add *some* value, if at all
possible...
--- Chris Borokowski <athloi -at- yahoo -dot- com> wrote:
> I would run this one by the legal department, since
> for an online
> application, they want to be very specific. "Your
> name" can mean just
> about anything to an internet user, so unless you
> want people typing in
> "Zorg-Amir, Elragon Dragonlord Level XIII" you
> should get the legal
> people to come up with some phrase like "Enter your
> name as it appears
> on your driver's license, passport or credit cards."
>
> --- l m <lm5582002 -at- yahoo -dot- com> wrote:
>
> > Has anyone had experience documenting such an
> interface? Do I really
> > have to write, "In the Name field, enter your
> name?"
>
>
>http://technical-writing.dionysius.com/
> technical writing | consulting | development
>
>
>
>
____________________________________________________________________________________
> Sick sense of humor? Visit Yahoo! TV's
> Comedy with an Edge to see what's on, when.
>http://tv.yahoo.com/collections/222
>
____________________________________________________________________________________Ready for the edge of your seat?
Check out tonight's top picks on Yahoo! TV. http://tv.yahoo.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-