Re: Tech writers and cookbooks

Subject: Re: Tech writers and cookbooks
From: "Michael Collier" <mcollier -at- arlut -dot- utexas -dot- edu>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 30 Jan 2001 14:46:41 -0600

I think good general technical writing principles would apply, like no more
than one step per instruction. An imperative statement ("do this, but not
that") could require an explanation.

If you are interested in learning XML, this would be a good exercise for it.
Think of all of the elements an XML recipe document should have:

<INGREDIENT>
<INSTRUCTION>
<STEP>
<IMPERATIVE>
<EXPLANATION>
...many others I'm sure...

Create a document type definition (DTD) that defines how these elements are
used (for example, you can require that an <INSTRUCTION> element contains
only one <STEP> element, and you can allow multiple <INSTRUCTION> elements;
further, if there is an <IMPERATIVE> element you can require that it has an
<EXPLANATION>.) Validate your recipe documents against this DTD.

After you've done all this and told Grandma that her beef stew recipe
doesn't conform to the DTD, order take-out as you won't have time to cook.

There is a good introductory article on XML in the April 1999 issue of STC's

Intercom that is very helpful (full text not online though).

................................................................
Michael Collier, Technical Writer Office: N546
Information Systems Laboratory http://isl.arlut.utexas.edu/
Applied Research Laboratories: The University of Texas at Austin
Voice: 512-835-3408 e-mail: mcollier -at- arlut -dot- utexas -dot- edu
................................................................


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17)
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area.
http://www.pdfconference.com or toll-free 877/278-2131.

---
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.


Previous by Author: Source Code Documentation Systems?
Next by Author: RE: Amusing terms
Previous by Thread: Re: Tech writers and cookbooks
Next by Thread: RE: Tech writers and cookbooks


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

Sponsored Ads


Sponsored Ads