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.
Re: Style convention question - fields, text boxes, etc.
Subject:Re: Style convention question - fields, text boxes, etc. From:"Barb Einarsen" <barb -dot- einarsen -at- gnnettest -dot- com> To:"MacLemale, Laura A. (LNG-MBC)" <Laura -dot- A -dot- MacLemale -at- bender -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 19 May 2000 15:01:11 -0400
> ...
> In the documentation, how would you describe these areas of the
application
> window that contain values that the user does not actually change?
>
> The first-draft writer calls them "fields," but that does not seem
accurate.
> We currently use "text box" to refer to the areas where the user will
> actually be entering information, so that term does not seem accurate
> either.
>
> (Also, do any of you have strong preferences for "text box" or "field" for
> screen areas where users add information?)
> ...
I tend to call editable and read-only dialog items fields and/or options
interchangeably. I identify the 'type' of dialog item in the field
description by using action words for editable fields (such as specify,
select, define) and non-active words for read-only fields (such as displays,
calculates, reflects)
For example, an editable Byte Size field may be described as:
"Byte Size--specify the maximum amount of bytes you want to send."
whereas a read-only field may be described as:
"Byte Size--displays the amount of bytes the software will send."
Hope this helps,
Barb Einarsen
Technical Writer
GN Nettest -- NOD