How would you handle this?

Subject: How would you handle this?
From: "Jessica Weissman" <Jessica -dot- Weissman -at- hillcrestlabs -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 13 Sep 2006 14:12:11 -0400

Below is an extract from some programmer-written documentation that I am
assigned to clean up. Notice that at the end of the third line it says
" and '<' for greater than". Yes, it uses the lessthan sign for greater
than. In defense of my colleague this is from the Java message spec.
He did not implement it this way.

What I've done is insert a footnote saying "This is not a misprint. '<'
really does mean 'greater than' here. See [URL to java documentation

Is this the best way? I don't want to break the example flow, but I
don't want to lose the information or have people either miss it or
write it up as a bug in the documentation. I think a footnote works
well. What do you think?


Jessica Weissman

The detail part of the choice type element contains a list of choices
separated by the pipe ( | ) character. Each choice consists of a
number, an equality operator (which may be '#' for equals and '<' for
greater than), and a format string.

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Comair Crash
Next by Author: poets as tech writers and programmers
Previous by Thread: RE: How important is up-to-date documentation? Was: RE: Gnaargh! Or, I Am Not Psychic
Next by Thread: RE: How would you handle this?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads