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:Naming cells in a grid From:Patrick Wright <pdoubleya -at- gmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 13 Mar 2005 12:08:59 +0100
Hi
I'm writing about an applicatin which includes a "spreadsheet"-style
grid. The grid is both editable and updated in realtime, and there are
a number of cases where the manual needs to refer to either the grid
or specific cells on the grid.
Oh, this app runs on Windows, so generally I'm following the Windows
style guide; but haven't see guidelines for this situation.
I'd like to establish conventions for talking about the columns and
cells on the grid.
I'll give a fake example (to not run afoul of non-disclosure
agreements). I am monitoring items I have for sale in an online
auction. My grid has one row for each item I have posted for sale. The
columns headers are
which are
item-desc: a description of the item
low-bid: current low bid on the auction
high-bid: current low bid on the auction
low-high diff: difference between low and high bids
target: minimum I'd like to receive
high-target-diff: difference between current high bid and target
cost: cost of the item (to me)
est-return: difference between high bid and cost (profit or loss)
Some use-cases for descriptions follow. "You" is the person selling
the items; ** means the text is highlighted (boldface):
1) If the item's high bid and low bid are the same, they will both be
coloured red
2) If the estimated return is positive, you have a profit, and the
estimated return will be coloured green. If it is negative, you have a
loss, and the estimated return will be coloured red.
3) The target column shows the amount you would like to receive for
the item, that is, the minimum bid you would like to accept. The cost
column shows the amount it costs you to produce or supply the item.
4) To hide the low bid for an item, open the context menu for the
item, choose *Hide Column*, and select *Low Bid* from the submenu.
5) To add a popup alert the first time a profit is projected for the
sale of an item, open the *Notify* menu, and choose Alerts. On the
*Alerts* dialogue, select the *Notify me on projected profit*
checkbox, then click *OK*.
Questions:
1) When is it better to refer to a column by on-screen name
("low-bid"), and when by the logical name ("the item's low bid")?
2) Should I use the words "column" and "cell", for example, "the
low-bid column" or "the item's low-bid cell"?
3) Should the column or cell names be highlighted, e.g boldface, as
they are GUI elements (like a button), or should I use italics,
quotes...?
4) Is there a good generic term for "grid" in this case, that is, the
block of rows and their columns? This application has more than one
grid on-screen.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Your Ad Here! Have a product or service you'd like to get some attention for? Use this space to get the word out! Contact lisa -at- techwr-l -dot- com for more details.
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.