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: Identifying the Figure Source in documentation
Subject:RE: Identifying the Figure Source in documentation From:"Harry Bacheler" <hbacheler -at- geo -dot- census -dot- gov> To:<Rhonda -dot- Perez -at- nokia -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 3 Mar 2000 09:13:00 -0500
My take -- Keep it in. It is another "HELP" that the end user can use when
talking to tech support.
It is 'always' needed by the reader, you just don't know when.
Remember, they sometimes have to describe the screen to the tech support
person, and do it in words
that may e totally off the wall. Like 'The coffee cup thingy", "in the
middle, where it says ..."
You can always use the "conventions" section of your front matter to explain
why it is there.
Harry M. Bacheler, Jr.
Consultant
VGS, Inc.
"The thoughts, ideas, and opinions expressed in my portion of this email
are mine and mine alone. They are not the thoughts, ideas, and/or
opinions of any past, present, or future employers, or any group that I
might belong to."
> -----Original Message-----
> From: bounce-techwr-l-20951 -at- lists -dot- raycomm -dot- com
> [mailto:bounce-techwr-l-20951 -at- lists -dot- raycomm -dot- com]On Behalf Of
> Rhonda -dot- Perez -at- nokia -dot- com
> Sent: Thursday, 02 March, 2000 04:23 PM
> To: TECHWR-L
> Subject: Identifying the Figure Source in documentation
>
>
> The figures in our customer documentation include the source number for
> internal reference. This is simply the .CGM number (approx. 8pt) in a box
at
> the bottom right-hand corner of each figure. Our doc team has opposing
views
> on continuing with this practice.
>
> Con: This information is not needed by the reader. This information will
> confuse the reader.
> Pro: This information is an Identification resource for internal customers
> and global documentation team members.
>
> I would like to know how other customer documentation teams handle this
> issue.
>
> Rhonda Perez
>
