Re: How to document column names?
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
Actually it's a battle between the user interface designers and the users - they just don't think of it in those terms. Plus, the managers who don't realize the war going on under their noses.
The way you are documenting it is fine, given the situation. If you are feeling ornery you could try the inverse of your method: If the thing is foo but it is labeled bar, document it as bar and provide a note explaining that bar really means foo.
A simple honest description of the situation should provide enough absurdity that someone with common sense will eventually notice it and possibly correct it.
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 printeddocumentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
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.
Previous by Author:
Re: Tina the Techwriter Reopens the Great Debate
Next by Author: Re: How to document column names?
Previous by Thread: RE: How to document column names?
Next by Thread: Re: How to document column names?
Search our Technical Writing Archives & Magazine