Re: A documetation suggestion (was Re: Cocoa et al as HCI usability problem)
Re: A documetation suggestion (was Re: Cocoa et al as HCI usability problem)
- Subject: Re: A documetation suggestion (was Re: Cocoa et al as HCI usability problem)
- From: Andy Lee <email@hidden>
- Date: Mon, 30 Jan 2012 11:14:39 -0500
A friend pointed me to a *really* interesting documentation browser with features along these lines. ("Classes and methods have their own wiki pages" is what reminded me of this old thread on cocoa-dev, but there's lots more.) I've only played with it a bit, but it seems very sharp and professionally done.
<http://kapeli.com/dash/>
> Snippet Manager Features:
> • Collect snippets of code that you reuse often.
> • Sync by saving your library in Dropbox.
> • Over 80 syntaxes for code highlighting.
> • Variable Placeholders can be edited before pasting.
> • Abbreviations are expanded wherever you type them.
> • Tag Cloud scales tags based on usage count.
> Special Snippet Placeholders:
> • @clipboard expands into the contents of the clipboard.
> • @cursor repositions the cursor after expansion.
> • @date expands into the current date.
> • @time expands into the current time.
> Documentation Browser Features:
> • Search Cocoa reference in iOS, Mac and custom docsets.
> • Classes and methods have their own wiki pages.
> • Methods are conveniently shown in a special Table of Contents.
> • Easily switch between platforms by clicking on search result icon.
> • Fuzzy search. Don’t let misspells get in your way.
> • Built for speed. Searching is almost instant.
> Other Features:
> • Multi-Touch Gestures.
> • Menu item application, always one keyboard shortcut away.
> • Users that want to use Dash only as a Snippet Manager or Documentation Browser, can do so.
--Andy
On May 22, 2008, at 6:22 PM, Scott Anguish wrote:
>
> On May 22, 2008, at 11:15 AM, Jonathan Hendry wrote:
>
>> Perhaps a better way of doing this would be a web or WebKit app with two panes. One that shows the Apple docs at Apple's site, and the other pane points to a page at a non-Apple wiki site that corresponds to the currently displayed Apple site.
>>
>> That would ensure that the Apple content stays up to date, while allowing unlimited wiki commenting.
>
> This is not just better, it is probably the best idea I've ever heard on this subject.
>
> if this was integrated into something like AppKido with the current CocoaDev.com wiki you could create everything you want without relying on Apple's involvement or buy-in.
>
> I'm not sure if AppKido currently takes advantage of the docset frameworks or not. but that would be the best way to meld these two things together.
_______________________________________________
Cocoa-dev mailing list (email@hidden)
Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden