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: field and file names From:"Susan W. Gallagher" <sgallagher -at- STARBASECORP -dot- COM> Date:Tue, 8 Aug 1995 09:55:39 -0700
Glenn Crumpley wants to know about setting off field names in
documentation and Solveig Haugland wonders about file names
in cross-platform systems.
The only thing I do to set off field names is to set them in
title case (all initial caps) and mention the type of widget
and/or the group name. Note that in Windows 95, widget labels
are not all title case on the screen, but I still use title
case to set them off in the doc. So, "Type the user's full
name in the User Name text box" -- and it seems to work well.
At least no one has ever complained about it. ;-)
As far as cross-platform filenames are concerned -- I just
use all lower case. Period. I've always hated the DOS convention
of putting filenames in all uppercase. Cross-platform development
gives me a perfect excuse to disregard that convention. If the
sentence seems too confusing, or if the filename is conversational
rather than in an easily recognized 8.3 format, I say "the
blahdeblah file" rather than just the name by itself.
Hope this helps.
Sue Gallagher
sgallagher -at- starbasecorp -dot- com
