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:Why We Need Good Software Manuals From:David Ibbetson <ibbetson -at- IDIRECT -dot- COM> Date:Thu, 1 Feb 1996 12:44:48 -0500
Tracy Boyington writes:
> > one problem we're seeing with new stuff, is "pointless help". got a
> > dialog box with a field that says "file name" and an OK function
> > button and you click the help key and get a nice dialog that says
> > things like "this is the file name field". no duh.
> This is my pet peeve and yet my engineers absolutely INSIST that I do
> this! I hate it! They want every field in every window and dialog box
> to have a separate topic. I've thrown fits but to no avail. How much
> can you say about a field titled "Last Name" or "City"? It's just
> plain ridiculous
Some useful things that can be said about Last Name or City, indeed about
virtually every field:
1) Number of characters allowed
2) Character set. Are accented letters allowed? What about spaces or hyphens?
3) Is there a default value?
4) May the field be left blank?
On a related topic, North Americans assume that everybody has exactly two
given names. I have three, my mother had one. (Every now and again in the UK
one hears about a child cursed with 26 names, one for each letter of the
What should I or my mother enter for "middle initial"?