• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: Documentation frustrations
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation frustrations


  • Subject: Re: Documentation frustrations
  • From: Raffael Cavallaro <email@hidden>
  • Date: Sat, 9 Jul 2005 02:25:07 -0400


On Jul 9, 2005, at Sat, Jul 9, 2:05 36 AM, m wrote:

I think what some of this boils down to is that there is a lot to know, and that a critical mass of knowledge is required before you can effectively bootstrap the rest.

I agree that the docs seem to have been written with this attitude. But this attitude - that there is a critical mass one needs to know before the docs become useful - more or less defeats the purpose of documentation. Documentation should be geared toward those who don't know what the docs contain. After all, if you already know what they say, you wouldn't be consulting them.


I realize that the higher level conceptual docs are intended to get one to this level of knowledge, but they fall short in my opinion in that they do not provide extensive enough sample code to be useful. As a result, I end up reading the API references, which also unfortunately lack sufficient sample code. But at least the API references have enough meat to allow one to figure out what the relevant sample code would look like if it existed.

regards,

Ralph

Raffael Cavallaro, Ph.D.
email@hidden

_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list      (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden


  • Follow-Ups:
    • Re: Documentation frustrations
      • From: Piers Uso Walter <email@hidden>
    • Re: Documentation frustrations
      • From: Charlton Wilbur <email@hidden>
    • Re: Documentation frustrations
      • From: Guy English <email@hidden>
References: 
 >Re: Documentation frustrations (From: Raffael Cavallaro <email@hidden>)
 >Re: Documentation frustrations (From: mmalcolm crawford <email@hidden>)
 >Re: Documentation frustrations (From: Raffael Cavallaro <email@hidden>)
 >Re: Documentation frustrations (From: mmalcolm crawford <email@hidden>)
 >Re: Documentation frustrations (From: Raffael Cavallaro <email@hidden>)
 >Re: Documentation frustrations (From: mmalcolm crawford <email@hidden>)
 >Re: Documentation frustrations (From: James Andrews <email@hidden>)
 >Re: Documentation frustrations (From: m <email@hidden>)

  • Prev by Date: Re: Documentation frustrations
  • Next by Date: Re: Documentation frustrations
  • Previous by thread: Re: Documentation frustrations
  • Next by thread: Re: Documentation frustrations
  • Index(es):
    • Date
    • Thread