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.
At 05:42 PM 9/22/99 -0700, Andy -dot- Kubrin -at- tanner -dot- com wrote:
>...Should I use brackets to show the variant ...
>or should I just present two alternate syntaxes...?
Akshully, both (or all) alternatives should appear within the
brackets, separated by vertical bars, so:
I've checked three manuals on my bookshelf for confirmation.
1. StarTeam (StarBase Corp) -- disclaimer, I wrote this one.
2 ClearCase (Atria, now Rational Corp)
3. Windows & Dos User Guide (MicroSoft)