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[2]: Variables in API documentation From:Janet_Valade -at- SYSTECH -dot- COM Date:Tue, 6 May 1997 07:56:50 PST
> For example, would you use:
> a) rm <filename>
> (using angle brackets that are not supposed to be typed as part of the
> command)
> b) rm *filename*
> (where the asterisks here are denoting italicized text)
> c) rm filename
> (no special demarcation)
My Unix/DOS bias (note that rm is a Unix shell command) rules the first
two out immediately since they already have a predefined meaning to
Unix/DOS shells.
I'm confused here. I prefer to use b). The UNIX books I have,
including the nutshell books which are pretty well accepted, use
method b). I agree method a) is not a good idea since some folks
will surely type the brackets. But, I don't understand what you mean
about method b).
Janet
Janet Valade
Technical Writer
Systech Corp, San Diego, CA
janet_valade -at- systech -dot- 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
