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:How to document column names? From:"Allen, Emily" <emily -dot- allen -at- teldta -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 11 Jun 2004 13:26:50 -0500
Hi,
I'm working on some on-line procedural documentation for a GUI and one of
the columns that I need to reference has a name that does not at all
represent what is displayed in that field. Any suggestions/standards as to
how to document this?
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?
Again, this is a battle between the Documentation Specialist and the
Trainer.
Thanks for your input.
Emily Allen | Documentation Specialist
Telephone and Data Systems, Inc.
8401 Greenway Blvd | Suite 230 | Middleton, WI 53562
T: 608.664.8249
emily -dot- allen -at- teldta -dot- com | www.teldta.com
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.