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.
James Barrow reports: <<Typical use case format. The bosses liked
it, but wanted a table in addition to everything else above. In this
table they want columns showing the Actors, Business Rules and
Metadata. I'm guessing that this Metadata is going to be the
encoding a user does to the data before it's entered into the DB.>>
Don't guess. "Metadata" means "information about the data", and
without pinning down the nature of the information, you could end up
spending hours documenting the wrong information. Your understanding
of this term probably differs from mine and that of your bosses.
<<I just can't figure out what to call the table. Criteria?>>
Once you know what they mean by "metadata", the correct word will be
easier to pick. And don't get hung up on finding a single-word
solution: sometimes "the best word" is actually a short phrase, such
as "Description of the data" or "Validity checks for controlling data
input".
----------------------------------------------------
-- Geoff Hart
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
www.geoff-hart.com
--------------------------------------------------
Coming soon: _Effective onscreen editing_ (http://www.geoff-hart.com/
home/onscreen-book.htm)
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com