writing commands

Subject: writing commands
From: "Carrie Baker" <carriebak -at- gmail -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 21 Nov 2006 21:43:28 +0200

The documentaion I am writing includes commands

The user has to type commands and fill in paramters which change
according to their local settings

"command x unit_type serial_numeber"
when unit type is the type of unit, either x, y or z and the serial
number is the number stuck on the back of your unnit

What is the best way of writing the syntax here, where do I explain
what should go in each of the fields in the command?

Carrie Baker
carriebak -at- gmail -dot- com

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! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

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
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: Plural of mouse
Next by Author: Re: Web application usability
Previous by Thread: Citations in proposals?
Next by Thread: Re: writing commands

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

Sponsored Ads