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:names in diagrams From:"Carnall, Jane" <Jane -dot- Carnall -at- COMPAQ -dot- COM> Date:Mon, 16 Aug 1999 14:25:08 +0100
Hi all,
I need to use a schematic diagram of the TinWood system in the introduction
to a user guide. I didn't originally create the diagram. One of the
functions represented on the diagram is an application that, I find, is
called tinwood_oz in the system. On the diagram, it is referred to as
Dorothy_TinWood_OZ (well, more or less :-) where Dorothy is the name of the
package for which tinwood_oz is one of the applications.
The system is case sensitive: tinwood_oz is different from TinWood_OZ. I
don't want to use tinwood_oz on the diagram, but I don't want to mislead
people into thinking that Dorothy_TinWood_OZ is the actual application name.
My proposed solution is to change the wording on the diagram to
Dorothy TinWood OZ - no underscores
but if anyone has any better ideas, I'd be glad to hear them! Send offlist,
if you would - I'm on digest.
It is difficult when trying to create or redesign a diagram, originally
created by an engineer, into something that is both technically accurate and
easily understood by end-users. All thoughts are appreciated.
Jane Carnall
Technical Writer, Compaq, UK
Unless stated otherwise, these opinions are mine, and mine alone.
