Re: Why is AS so poorly documented?
Re: Why is AS so poorly documented?
- Subject: Re: Why is AS so poorly documented?
- From: Dave Balderstone <email@hidden>
- Date: Wed, 23 Jul 2003 08:37:33 -0600
On Wednesday, July 23, 2003, at 12:56 AM, Matthew Smith wrote:
Current documentation for AppleScript may include some documentation
for
some scripting additions (like Standard Additions) and application
dictionaries (like Finder), but can't cater for all scripting
additions and
application dictionaries. Of course, trying to document scripting
additions
and application dictionaries in documentation for AppleScript is quite
difficult, when they can change quite quickly. As has been stated
recently,
there is a difference between the dictionaries for iTunes 4.0 and
iTunes
4.01, and there was only a few months between there releases.
Which brings the discussion back to a point I've seen raised here
before, that many people find the AS dictionaries obtuse and difficult
to read.
I rather think the problem is that the dictionaries are written in a
dialect that people (this is a BROAD generalization) haven't taken the
time to learn. EG:
set reference -- the object for the command
Result: anything -- the reply for the command
looks confusing as hell to someone looking at it cold, but after
working with AS for a period of time and learning the dialect (via the
language guides, the various books on the market, and excellent web
resources like MacScripter and The AppleScript Sourcebook to name just
two) it's easy to understand.
So, I wonder... when people cry for "better documentation" are they
just looking for an example (perhaps in the app's dictionary) per entry
or are they really looking for step-by-step "how to" guides?
As an analogy, I see a big pile of Lego pieces. Do I just need some
pictures of *some* things that *can* be built with the pieces I have,
or do I require detailed instructions to build specific things?
djb
_______________________________________________
applescript-users mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/applescript-users
Do not post admin requests to the list. They will be ignored.