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: Variables in API documentation From:Peter Brown <pbrown -at- MKS -dot- COM> Date:Tue, 6 May 1997 12:15:25 -0400
Using special characters to denote variables is a practice made
necessary by the limitations of ASCII. If you still distribute text-only
documentation, such as a readme.txt, then you may still have to cling to
this archaic habit.
But in the age of bolding, italics, and a plethora of fonts, the utility
of special characters is outweighed by the chance that they may be
misinterpreted.
Out of every 10 API documentation sets I see, I'd say that 8 use italics
to indicate variables.
--
---------------------------------------------------------------
"Opinions? I've had a few. But then again, too few to mention."
Peter Brown, Technical Writer (pbrown -at- mks -dot- com)
Mortice Kern Systems Inc. (http://www.mks.com)
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
