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:A Survey: Do You Name Your Images in a Std Way? From:"Barbara Vega" <BarbaraV -at- libertyims -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 23 May 2007 22:51:53 -0700
Hi all:
When you write your documentation and you are making images galore -
whether it be an electronic document (in Robo or whatever) or PDF or
what have you, and you are making images as you go along going back and
forth to the software, going through it as you go capturing and pasting
and going through the steps and putting the images in, do you name your
images in a standard way, or do you name them haphazardly?
For example:
Do you name them with some convention, like all the buttons start with
an abbreviation BTN-SOANDSO And all the dialogs DLG-soandso? Or
4BTN-soandso - to denote Version 4 of the software, etc?
Or do you just name them Figure1 Figure2 Figure 3 to follow the numbers
they are in the manual?
Or do you just name them something that describes what they are like
FlderView1, DialogUoponEntry, LoginBtn, etc.
I am curious as to how many of us standardize this, and if you find it
helps.
Thanks
Barb
"This message is for the named person's use only. It may contain confidential, proprietary
or legally privileged information. No confidentiality or privilege is waived or lost by any
mistransmission. If you receive this message in error, please immediately delete it and all
copies of it from your system, destroy any hard copies of it and notify the sender. You must
not, directly or indirectly, use, disclose, distribute, print, or copy any part of this
message if you are not the intended recipient.
If you receive this communication in error, please notify us immediately by telephone (collect)
at (714) 751-6900 and return the original message to us at the above listed address via electronic
mail. We will reimburse you for telephone expenses involved. Thank you."
Scanning of this message and addition of this footer is performed by SurfControl Email Filter
software in conjunction with McAffee virus detection software.
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-