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:RE: How to document column names? From:David Demyan <ddemyan -at- coppercom -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 11 Jun 2004 14:33:07 -0400
Emily wrote:
>>I have chose to use the name that the GUI displays and then included a
note
informing the user what the column represents. Is this going to cause users
anxiety when looking at the documentation? Am I going to be confusing
them?<<
I had a similar problem. A window with columns had so much text in the
headings that the screen shot of the window only showed "Na...", "Cus...",
"Add..." etc. When explaining the columns, I didn't want to show the cryptic
names since the column width, and therefore the amount of the name showing,
was adjustable. So, I put callouts on the screen shot with the full column
heading name, then referenced that in text.
This may work for you.
Dave
NOTE: This message, including any attachments, may include privileged,
confidential and/or inside information. Any distribution or use of this
communication by anyone other than the intended recipient(s) is strictly
prohibited and may be unlawful. If you are not the intended recipient,
please notify the sender by replying to this message and then delete it from
your system. Thank you.
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
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- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
