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:"Chinell, David F (GE Indust, Security)" <David -dot- Chinell -at- GE -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 10:12:07 -0400
Without much reflection...
Naming files for their figure numbers is probably a bad idea as figure
numbers are supposed to be able to slide around (change values) as the
content changes.
My personal favorite for high-volumes of application-named images is a
purely meaningless serial number. More and more, the software tools let
you select and access image files without needing to know the file
labels.
You probably only need a formal convention if more than one person is at
work on the project. Formal conventions should be established in a
department-wide style guide, or included in a ReadMe or design document
for the product library.
I have a personal suspicion that attempts at developing labelling codes
or conventions are only valuable as brief entertainments, and the
results have no lasting value, and slim chance of being sustained after
the original heat of development cools.
We create printed documents with Word. These contain drawings created in
CorelDraw. The author need not save the drawings externally to the Word
document. That is, we use CorelDraw as if it were an add-on tool for
Word. To revise a drawing, we copy it from Word into CorelDraw, edit it,
then copy it back into Word.
If the author is wary of this approach, he can save the drawings
externally to the document. The drawings can be in a single CorelDraw
file with several pages, or in a folder containing separate files. In
either case, the single file or folder must bear the document part
number, and be located in the root of the document folder. Example:
5559010 R3.0 WhizBang User Manual
--5559010 Drawings
----Product ID.cdr
----Wiring diagrams.cdr
----Mounting with cabinet.cdr
----Mouning on wall.cdr
--Work
----5559010 R02.12.doc
----5559010 R02.13.doc
----5559010 R02.14.doc
--5559010 R02.15.doc
We used to embed file labels or serial numbers right in the drawings,
but found that there was actually no call for this kind of
identification. (And it always looked clunky.)
For RoboHelp projects we put all the images in a single subfolder. They
can be labeled with pure serial numbers or with codes or full English
names that are meaningful to the author.
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-