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:"Steve Cavanaugh" <scavanaugh -at- nat-seattle -dot- com> To:"Barbara Vega" <BarbaraV -at- libertyims -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 24 May 2007 07:10:52 -0700
If you name them as "Figure1, Figure2," etc. there is no question that
once you get to Figure 32 you'll have to insert a new figure between
Figure 3 and 4, and you'll be faced with either renaming all subsequent
figures, or leaving them incorrectly named. Every dialog and window has
a name in the title bar - I use that because it always has direct
correlation, no matter where I use it. But I like your idea of
including a version string as well.
Steve Cavanaugh
> Barbara Vega said about A Survey: Do You
> Name Your Images in a Std Way?
>
> 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
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-