Re: Question on Naming

Subject: Re: Question on Naming
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 7 Jan 2010 08:53:26 -0800

If by "using Eclipse to create the application" you mean they're using
Eclipse Web Tools, there should be no need to invent terms. If the
programmers are just using Eclipse as an IDE, that's not necessarily
meaningful, especailly if it's written in C++ rather than Java.

You should find out this stuff before you start inventing new terms,
especially since it should affect your deliverables.

I would not call a UI "dynamic" just because elements are shown or
hidden based on the user's role / permissions / group membership. A
particular user will always see the same thing.

Is the doc task-oriented or what?

"I may just call them by their tab name of History, Calender, etc."

That's probably best. Generally, with Web-based UIs where you've got
multiple levels of tabs and various panels in a flat workspace without
overlapping windows or pop-ups, I find it clearer to avoid naming UI
elements. Especially when the UI is messy, disorganized, and
inconsistent, as in Oracle apps.

In any case, "action item" and "screen" are weird and confusing.

On Thu, Jan 7, 2010 at 8:25 AM, Robert Courtney <bobsc1 -at- earthlink -dot- net> wrote:
> Robert,
> This is a new application in essence, but is predicated on an application
> that is currently in use. It adds functionality to an existing product, but
> it is not part of the product. It exchanges data with the database as well
> as create it's own data. It does not exactly duplicate the data, but does
> store some of the same data to use and then expands on it to provide the
> functionality needed.
> The application it works with is a windows application. Not sure of the tool
> they used to create it, but would guess visiual studio and probably done in
> C++ or something there abouts. The new application is completely web based
> with a DB and servers. They are using eclipse to create the application. Not
> sure if they are using Swing for the UI.
> The layout is a collapsible explorer bar with a main display. The main
> display changes pages/screens. The content varies depending on users
> authority level. So, one user will get an edit button and a save button. A
> supervisor will get an edit button, save button, submit button, lock button,
> flag button, etc. Depends on what they are doing. So, things are dynamic.
> The current application they have call some things they do "events". But
> that doesn't define the tabs or the items in the tabs. They basically use
> the name of the object and that's it. Eg., History, Calendar, Calendar View.
> I am looking for a way to label these objects in the tabs that makes sense
> and when called if they are screen, panel, display, etc.
> I need to make sense to the user and not confuse them. I may just call them
> by their tab name of History, Calender, etc. And work with it.
> What I was/am looking at is a way to name the items so it makes sense when
> talking about them. Such as the History Action Item lists of all the changes
> to your record with name, date, change, etc. And I use displays the result
> in the main display area (defined as the right pane/panel of the screen).
> I hope that explains it better. And I have another question on Robohelp and
> doing narrative help with no TOC showing but able to open it if you want it.
> Like the new Windows 7 help. Any ideas on how to use Robohelp to make it
> look like that?

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:

Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at:

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:

Question on Naming: From: Robert Courtney
Re: Question on Naming: From: Robert Lauriston
Re: Question on Naming: From: Robert Lauriston
Re: Question on Naming: From: Robert Courtney
Re: Question on Naming: From: Robert Lauriston

Previous by Author: Re: Question on Naming
Next by Author: Re: Uninstalling Adobe Trialware
Previous by Thread: Re: Question on Naming
Next by Thread: RE: Question on Naming

What this post helpful? Share it with friends and colleagues:

Sponsored Ads