RE: writing commands

Subject: RE: writing commands
From: mlist -at- safenet-inc -dot- com
To: lori_olcott -at- yahoo -dot- com, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 24 Nov 2006 13:19:23 -0500

Lori Olcott [mailto:lori_olcott -at- yahoo -dot- com] confidently suggested:

> I use brackets to show a limited choice or option for a user.
> I like to
> use italics for elements that are less restricted than a choice option
> (like serial numbers or field values), but some style guides or venues
> don't allow for that. More brackets or a different style of
> bracers would
> also serve well.
> e.g.
> > init [basic/pro/delux] {serial_number}
> basic, pro, or delux is the unit type
> serial_number is the number found on the back of the unit

... and preceded by "Ser." or "S/N" or "S#", and not to be confused
with any of the dozen other numbers back there, such as:
- Part Number
- model number
- Service Tag
- default IP address
- shoe size
- marked-down price
- percentage of alcohol
- sudoku
- toll-free Help number... :-)

The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it.

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Linux
Next by Author: Temp/permanent annotations?
Previous by Thread: Re: writing commands
Next by Thread: Using learning theory to build learning documents

What this post helpful? Share it with friends and colleagues:

Sponsored Ads