Documentation of Scripting

[walter -dot- crockett -at- ascentialsoftware -dot- com]

I am updating documentation on using scripts to run our software from the
DOS command line. The current documentation is not written in a standard API
form, and it is often difficult to tell which information is supposed to be
part of the script the user writes(a VB-type script), and which is supposed
to be included in the command.

I have dealt with API manuals before and found that the attitude among the
engineers who spec them out seems to be that anyone who can write scripts
doesn't need any hand-holding. However, I'd prefer to create a document so
clear that even a novice (with some understanding of programming languages)
could learn how to script the tool.

Are there any good books on this subject, or standards to follow? If you
have an example you are proud of, please send it my way.

Thanks,
Walter Crockett 

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A landmark hotel, one of America's most beautiful cities, and 
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.  http://ieeepcs.org/2001/

  +++  Miramo -- Database/XML publishing automation.  See us at  +++
  +++  Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion  +++
  +++ More info: http://www.axialinfo.com  http://www.miramo.com +++

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit 
http://www.raycomm.com/techwhirl/ for more resources and info.