Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: René van Amerongen <email@hidden>
- Date: Sat, 9 Jul 2005 12:24:05 +0200
I agree with points from both sides, references is reference, Docs
are docs but it would be nice if there where more links to sample
code with more comment between the lines.
I think there should be only three things:
Reference with links to the Docs
Documentation with links to Samples and Ref
Samples inside Tutorials ( even the smallest sample should be in a
tutorial. With lots of comments between the code lines )
One possible remedy comes to mind:
At the top of each class reference is a box that lists, "Inherits
from", "Conforms to" etc. This seems like a reasonable place to
also list categories. Would this be an acceptable solution? If
so, please... :-)
mmalc
Please do. Mayby not the solution, but a good starter.
About the documentation pages there is a table with
Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.
Is apple using this really?
I am curious, how many people files a bug about documentation this
way or any other ways?
It would also be nice if apple added the page name somewhere on this
'Document feedback' page instead of the overall document name. I know
its hidden but it would be nice to show the real place where we are
reading.
Thanks
Rene v Amerongen
_______________________________________________
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