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'm on digest, and I know someone said this already, but you've had a lot
of other answers too.
I would definitely provide an example. You could say:
The name_pairs are separated by a comma. Example: apples, oranges.
(Substitute appropriately realistic name examples, add parenths if needed.)
Your typography would have to make it clear exactly where your example
began and ended: boldface, italics, separate line, whatever.
This would give the reader more understanding than simply telling them what
a comma is, without seeming to talk down.
Best,
Gen
Gen Whitt
Senior Technical Writer
Software Dynamics, Inc.
West Hills, CA
