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.
Find any software, commercial or non-commercial, where the title of the
screen does not match what you can do on the screen. You don't need
1000s of TWers for this one. QA should be screaming their heads off. Get
customer support involved if you need to.
Sure, you can get around the screen name in the doc/help by just citing
the path for verifying that something is set up. Off-the-top-of-my-head,
|
If the records are not being processed, verify the "Allow Processing"
check box is selected. Click File ==> Properties ==> select the "Allow
Processing" check box. Click Ok
|
In my opinion, if I as a user select a menu option called "Service
Location Maintenance," I expect the window I see to have some reference
to "service locations." One standard is that the menu option verbiage
and the title of the screen that displays match. For example, for the
above example, the title of the window that displays is "Service
Location Maintenance." In the same way, if I am processing invoices, I
would think the screen should indicate that you are processing invoices.
If you have to go through multiple windows, each window should have a
unique title.
As for 'no title' windows, if you have multiple screens that don't have
a title, how does customer support know which 'untitled' screen they are
looking at? If you get a screen capture from a customer of just an
untitled screen, how do you know where it is? Better yet, how does a
*new* customer support person know where it is at? These may not apply
to your situation, but they would to mine.
Around here, there is a standard and then there is the way we do things.
Part of QA's job is to negotiate the chasm between them.
-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Zen C
Sent: Friday, August 24, 2007 2:17 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Importance of proper screen names
<snip>
I have to document a software that has either no screen name or some
silly screen name that doesn't make sense. How important do you'll think
it is to have meaningful screen names for documentation. Do you'll
always refer to a screen?
For example:
On the File menu, click Properties. The Properties dialog box displays.
I noticed in word, that there is no reference to dialog boxes. What is
the common method followed?
If the users are very well aware of what they are doing, lets say a
doctor using some health care software do they really pay attention to
the screen names, when reading the help file or do they know where they
would be taken to and they don't find it important.
comments please.
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 PHanson -at- quintrex -dot- com -dot-
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-
