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:Jan Cohen <najnehoc -at- yahoo -dot- com> To:Zen C <zenizenc -at- gmail -dot- com> Date:Mon, 22 Oct 2007 11:41:10 -0700 (PDT)
You're welcome, Zen. You also ought to keep in mind what the others
said about keeping things simple. How simple will depend on your
audience and what their expectations are. For instance, if you're
writing to a non-technical audience, clicking on the "payments tab"
should do just fine.
jan c.
----- Original Message ----
From: Zen C <zenizenc -at- gmail -dot- com>
To: Jan Cohen <najnehoc -at- yahoo -dot- com>
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Monday, October 22, 2007 12:34:32 PM
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,
What your describing sounds like the front end for a database(s) of some kind that's probably hosted on a remote machine. If that's the case, each of the ten modules is used to interface with the database, in a client-sever relationship, to perform a specific set of tasks. If I'm on track here, it then follows that clicking on a module on a client's machine opens an actual interface, one of your tabbed windows, to perform that module's specific set of tasks. Because all the data is stored in,
e.g., the centrally located database, any of the ten modules can be be set up to perform whatever you will, even if some tasks are duplicated among the modules. Of course, all of these statements are assumptions on my part, since I haven't actually seen the entire set up. But I think I'm making some pretty good guesses.
Correct me if I'm wrong, but I'm also guessing that your audience consists of users with various levels of experience. I'm not sure any one term would adequately describe what's going on to laypeople, but it should suffice for those with more experience. That term would be "interface." You could then precede that term with each of the module's official names, in each of instance,
e.g., "the booking module interface, the scheduling module interface, the booking and scheduling modules interfaces," etc. The fact that the complete application is made of 10 unique modules (or smaller "applications") will become inherent, because you will have described it as such in your introductory material. And if you've done that properly, even those with minimal experience should be able to grasp all the concepts.
Does that help some?
jan c.
----- Original Message ----
From: Zen C <
zenizenc -at- gmail -dot- com>
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Monday, October 22, 2007 7:01:24 AM
Subject: Re: What is the best term to use?
wow, so many e-mails back and forth while I was sound asleep.
This is how the software is designed. The main application is broken in to
10 main module. When you click on a module you get a tabbed window. About 5
tabs per window which has no link to each other. Using each tab you can
perform different tasks. For example: The application consists of a
Transaction module, Financial module, Scheduling module etc.
You click the payments tab to do all payments related tasks. Since the
software is deigned to do the same task in different ways. The same
tab/window/application can be accessed trough the Financial module as well.
The Book application/tab/window is accessible through the Scheduling module.
So you can do all booking related tasks using the book
tab/window/application in the Scheduling module.
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-
