RE: Boolean value: Whether or Not or IF

["Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>]

If there is a value format column specifying that the value is a
Boolean, I use descriptions of the form:

Determines whether the Back button is visible.  If yes, the back button
appears, otherwise not.

I try to paraphrase the item name, just in case the original formulation
is ambiguous or difficult for some developer to understand.  Using
different wording in the description column adds value, IFF the meaning
is not changed at all.

In this case, I am assuming that the button only appears on the screen
if it is enabled.  

-  Jessica

-----Original Message-----
From:
techwr-l-bounces+jessica -dot- weissman=hillcrestlabs -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jessica -dot- weissman=hillcrestlabs -dot- com -at- lists -dot- techwr
-l.com] On Behalf Of Rob Hudson
Sent: Thursday, September 18, 2008 3:03 PM
To: 'techwr-l List'
Subject: Boolean value: Whether or Not or IF

Hello Everyone,

If you're describing a boolean column in a document, for example 
"EnableBackButton," would you describe it as:

"Whether or not the back button should appear on the screen" or
"If the back button should appear on the screen" or
"Should the back button appear on the screen?"

I'm getting nitpicky with my wording of boolean settings.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help gives you everything you need to author and 
publish quality Help, Web, and print content. Perfect for technical 
authors, developers, and policy writers. Download a FREE trial.
http://www.componentone.com/DocToHelp/

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
Jessica -dot- Weissman -at- hillcrestlabs -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/jessica.weissman%40hi
llcrestlabs.com


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.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help gives you everything you need to author and 
publish quality Help, Web, and print content. Perfect for technical 
authors, developers, and policy writers. Download a FREE trial.
http://www.componentone.com/DocToHelp/

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- 

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/archive%40web.techwr-l.com


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.