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:RE: What is the best term to use? From:"Tariel, Lauren R" <lt34 -at- saclink -dot- csus -dot- edu> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 22 Oct 2007 11:36:27 -0700
"Interface" is too easy. I like the term. I want a dictionary of terms that I take for granted and are obvious when I don't think about them.
In my app of many tabs, where some of the sub-tabs are being replaced by a new tab and all of the main tabs are called "screens" and the sub-tabs are called "applets," and sub-sub-tabs are called "tabs," I think that "interface" could be a useful term. However, the entire Siebel application, with a name that people do not use because it has the same name as a half-dozen other components of the system (idiot programmers), is called an "interface," sometimes.
There are also many main tabs (screens) and sub-tabs (applets or tabs, depending on who's talking) that share names but not functionality. The system, a main tab, a sub-tab, and a physical object used in the process all have the same name, "case." Additionally, "case" is used as part of the name of other components. Other terms are frequently and similarly recycled, like "person" and "application." So calling a thing by its name is confusing, to say the least. Calling things by their function or their status in the system can help. Keeping the names separate is important while working with this application and while working with the development project that is making changes to the application. Plus, I'm limited to the terms that the client uses.
I tried to illustrate the problem of giving things the same name during a meeting and found myself tripping over words when I tried to say "For a case where..." I had a difficult time describing the problem without saying "case." I needed to force myself to say "in an instance..." or something similar. The application that I'm dealing is certainly not typical of well-designed applications.
In my case (there's that word again), there is no getting around lame naming conventions and the use of terms that become confusing when compared to real world examples of those terms. But in a case where terminology is a little more flexible, then "interface" makes sense.
Lauren
________________________________
From: techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com on behalf of Zen C
Sent: Mon 10/22/2007 9:34 AM
To: Jan Cohen
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: What is the best term to use?
Bingo! You got it! I think interface sounds good:), Thanks Jan.
Also a big thank you to all for helping me figure this out.
On 10/22/07, Jan Cohen <najnehoc -at- yahoo -dot- com> wrote:
>
> Zen,
>
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
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-