Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Steve Weller <email@hidden>
- Date: Tue, 12 Jul 2005 21:46:07 -0700
At 12:32 AM -0400 7/10/05, Erik Buck wrote:
Really finally. Please learn how to use a search tool with
documentation. I recommend google. Note the VERY FIRST HIT:
http://www.google.com/search?client=safari&rls=en&q=NSWindow+hide&ie=UTF-8&oe=UTF-8
You don't even have to follow the link. The answer is in the
SUMMARY provided by google.
It strikes me that one of the documentation deficiencies is not that
the information is missing, it is that it cannot be found quickly
from the place one is looking. And the place you are looking, from
the perspective of the potential annotator is read-only.
But Google, with its all-seeing index can make those jumps for you,
*if* you know what to search on.
So here is an idea. In the reference docs, put a unique visible ASCII
tag by each method, constant, class etc. Anyone who wants to annotate
that item writes their annotation on their own web page and includes
the tag that is unique to the item. The item in the Apple docs
includes a graphic with a link that fires off a Google search for the
tag, and bingo, up come all the public annotations. This will survive
all the editing, reordering, renaming, renumbering, etc. that
ultimately breaks hyperlinks and gets around the read-only problem.
You could call it lazylinking, or googlinking I guess. With some
Javascript clevernness you could load and display all the annotations
in a separate frame as you mouseover the item.
--
How much art could an artichoke choke if an artichoke could choke art?
_______________________________________________
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