views:

197

answers:

8

I'm looking for examples of companies who do great API documentation. Flickr's looks really nice. Any recommendations?

What's apparent to me is that there are differing definitions of what "great API documentation" actually is. I'm looking for examples that combine nice design/usability with extensive and accurate documentation.

So far, Flickr and Last.fm encompass these aspects the most. I can open them up and know right away what and discern the information I'm looking for.

+2  A: 

jQuery has great documentation.

Consensus has it that last.fm has good documentation as well.

Justin Niessner
+1 it has indeed
David Hedlund
Well, I have to say I'm not super-impressed with the 1.4 jQuery documentation. Particularly when the first time I click on something it takes me to the top of the page and doesn't navigate the link. Can't believe they haven't fixed that yet.
cletus
@cletus - works on my machine...
Joel Mueller
A: 

Yeah, flickr is well documented. last.fm is in the same vein.

David Hedlund
+3  A: 

MSDN Library for the .NET Framework is probably the best API documentation I'm aware of.

The thing I like is that you can find, for almost every method overload, a complete code sample that shows how to use the API. That's even true for not-so-used methods, like ILGenerator.Emit, for example. You get signatures and code samples in different .NET languages (C++ CLI, VB.NET, C# ; sometimes F#), plus valuable remarks.

Note that the .NET MSDN library also contains lots of pages about concepts, guidelines, how-to's, etc.

For example, here you can find a whole set of links that explain what is the reflection, and how to use this framework part at a higher level. It explains ideas and concepts over the simple API usage : runtime types, how to handle generic types, security, metadata, etc.

Only few projects, frameworks and tools that I know of, have such a detailed documentation.

Romain Verdier
+5  A: 

I must admit that MSDN is not so bad.

Vlad
I'm afraid that MSDN is too large and only a partition of it is excellent. I can find garbage like "It is itself" from time to time.
Dennis Cheung
Well, at least when I need some info on the areas documented by MSDN, most of the time it's there and helpful. However usually I use Google to find the needed piece of information there. :-P
Vlad
+2  A: 

Qt's documentation is my favourite.

erelender
+3  A: 

Java's documentation is also top-notch.

Greg D
Yes, since Java 5 the JDK documentation is really good. For example, it -- in most cases -- covers also the corner cases, the assertions, what is allowed to be changed from version to version.
dmeister
+1, Love javadocs.
Zachary
+1  A: 

Django's is pretty impressive.

Gives a nice "Get started now" tutorial, which is a must, but also has very approachable documentation for when you need more info.

Edan Maor
A: 

Google Maps isn't too bad.

http://code.google.com/apis/maps/documentation/index.html

Eric Palakovich Carr