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: How to name a window in documentation From:"Bruce Megan (Telex)" <Megan -dot- Bruce -at- us -dot- bosch -dot- com> To:"voxwoman" <voxwoman -at- gmail -dot- com> Date:Mon, 3 Nov 2008 13:24:10 -0600
I too, hope that I never have to use equipment that refers to itself as
a Box. In my example, box was being substituted for the actual name of
the product to protect the innocent :-).
That said, I like the idea of using "Device". That is just vague enough
to work in a title heading with out having to explain what it means
(hence, the XXXX, where XXXX means.... Statement).
Megan Bruce
Documentation Specialist - ST-CO/ENG2.2
Bosch Communications Systems
Telex Communications Inc.
12000 Portland Ave. S.
Burnsville, Minnesota 55337
USA
www.boschcommunications.com
Tel: 952 736 3910 mailto:megan -dot- bruce -at- us -dot- bosch -dot- com
-----Original Message-----
From: techwr-l-bounces+megan -dot- bruce=us -dot- bosch -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+megan -dot- bruce=us -dot- bosch -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of voxwoman
Sent: Monday, November 03, 2008 1:10 PM
To: Bruce Megan (Telex)
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: How to name a window in documentation
I hope that I never have to use equipment that refers to itself formally
as a "box" (unless it's made out of cardboard and used to hold other
things).
are the individual box windows inside the "all boxes" window, or are
they separate? Going under the assumption that these are separate
windows, I would possibly name the various windows the "aggregate
window" (for all
boxes) and the "device window" (for each device). I would also consider
using the specific device type, if all the boxes are the same type of
device, for ex, "router window".
HTH
Wendy
On Mon, Nov 3, 2008 at 12:41 PM, Bruce Megan (Telex) <
Megan -dot- Bruce -at- us -dot- bosch -dot- com> wrote:
> Hello All,
> I am in a bit of a quandary.... I am trying to write Screen
> descriptions for a software application. Easy enough you may
> say,....well here's where it gets a bit tricky:
> A little background - The software I am working with is specific to
> the hardware it is hooked up to. For example, Box A (aliased New York)
> can talk to Box B (aliased Los Angeles) can talk to Box C (aliased
> Akron) and so on and so forth, due to t h! is software. If I select
> the option All Boxes, the window caption shows "All Boxes" and
> displays all the pertinent information for every box in the system.
> However, if I select a specific box, the window caption says New York
> Box, Los Angeles Box, or Akron Box.
> My question is as follows:
> "Because the window showing all the boxes displays different
> information, than the window that displays the individual box, how do
> I go about giving a generic term to the specifically chosen box?"
> I don't like using XXXX Box (where XXXX represents the alias of the
> box) Does anyone have any suggestions on how to get around this?
> Thanks in advanced.
> Megan
> Megan Bruce
> Documentation Specialist - ST-CO/ENG2.2 Bosch Communications Systems
> Telex Communications Inc.
> 12000 Portland Ave. S.
> Burnsville, Minnesota 55337
> USA
> www.boschcommunications.com <http://www.boschcommunications.com/>
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> ComponentOne Doc-To-Help 2009 is your all-in-one authoring and
> publishing solution. Author in Doc-To-Help's XML-based editor,
> Microsoft Word or HTML and publish to the Web, Help systems or printed
manuals.
>http://www.doctohelp.com
>
> Help & Manual 5: The complete help authoring tool for individual
> authors and teams. Professional power, intuitive interface. Write
> once, publish to 8 formats. Multi-user authoring and version control!
>http://www.helpandmanual.com/
>
> ---
> You are currently subscribed to TECHWR-L as voxwoman -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/voxwoman%40gmail.co
> m
>
>
> 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
>http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and
publishing solution. Author in Doc-To-Help's XML-based editor,
Microsoft Word or HTML and publish to the Web, Help systems or printed
manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual authors
and teams. Professional power, intuitive interface. Write once, publish
to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as megan -dot- bruce -at- us -dot- bosch -dot- com -dot-
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
