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.
I am documenting a custom VB application that uses the Sheridan ActiveX
controls. One of the controls is the ActiveList, which most of us know from
the Outlook 98 interface, and the other is a TreeView control that shows
topics and subtopics in a hierarchy.
My question is this--has anyone dealt with naming conventions for these
controls in product/training documentation? If so, I would appreciate
suggestions because I am trying to establish names that the audience will
understand, and at the same time I am trying to avoid awkward and clumsy
phrasing.
For the ActiveList, Microsoft calls the whole of the control the Outlook
Bar, and within that bar you have Groups (the horizontal bars that scale up
and down), and within Groups you have Shortcuts. This terminology seems
reasonable, and I like the idea that it is consistent with Microsoft
conventions (those of you who flame on standards, calm down . . . ).
For the TreeView, Sheridan refers to RootNode and Node and obviously these
won't fly with end users. Currently I am calling the entire control a Topic
Tree, and within that Topic Tree you have Topics and Subtopics.
Any comments on experience with these controls would be appreciated.
========================================
Graham Tillotson, Senior Consultant
Whittman-Hart, Inc. Chicago, IL
========================================