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: A Survey: Do You Name Your Images in a Std Way?
Subject:RE: A Survey: Do You Name Your Images in a Std Way? From:"zzPinkham, zzJim" <Jim -dot- Pinkham -at- voith -dot- com> To:"Martinek, Carla" <CMartinek -at- zebra -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 24 May 2007 09:17:28 -0500
It's a valid point. For us, it wouldn't be a problem unless both Fig_10
and Fig_11 were rotating assemblies for the XYZ 10, which is not likely,
probably not possible. In other words, the rest of the name is
sufficient for identification.
But it does raise the specter of having to rename all the subsequent
images in the chapter to fit the new one in. That would be troublesome.
The other option would be to cheat a little and add something unique to
the new figure's filename that didn't disturb the sequence. Of course,
that's not ideal, either. So I appreciate the food for thought.
In any event, both of us are reinforcing the case for standardization
that OP asked about: The more room for inconsistency or lack of clarity
equals the more room for grief.
-----Original Message-----
From: techwr-l-bounces+jim -dot- pinkham=voith -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jim -dot- pinkham=voith -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Martinek, Carla
Sent: Thursday, May 24, 2007 9:00 AM
To: TECHWR-L
Subject: RE: A Survey: Do You Name Your Images in a Std Way?
-----Original Message-----
So, where we're at now is something more along the lines of
Fig_10-1_XYZ_10_Rotating_Assembly.eps. At this point, we at least have a
fighting chance of turning up what we need quickly in a search or a
visual scan of filenames.
---------------------------
One question... What happens when you add a new figure, and Fig_10 now
becomes Fig_11 in your doc?
Perhaps there is a way that it can work for some groups, but I've
avoided naming graphics by their figure numbers for as long as I can
remember for just such a reason.
-Carla
- CONFIDENTIAL-
This email and any files transmitted with it are confidential, and may
also be legally privileged. If you are not the intended recipient, you
may not review, use, copy, or distribute this message. If you receive
this email in error, please notify the sender immediately by reply email
and then delete this email.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 Jim -dot- Pinkham -at- voith -dot- com -dot-
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-