views:

902

answers:

14

I ask because I am in need of some examples of spectacular documentation to do a little compare/contrast. Bad documentation abounds but who gets it stone cold correct?

I suppose we should differentiate between documentation geared at informing experts and documentation geared at teaching new users but if you know of something that combines both of these, by all means reveal!

+1  A: 

I've found the Django documentation to be quite useful. Its tone is conversational, with snippets interesting for beginner visually distinguished from the main reference text, so as to be easily filtered out by the expert user. Its style is visually clean and textually logical, in that it closely tracks my thought process from "WTF is Django" do "how do I solve specific Django implementation issue X for my project?"

Matt J
Also the http://djangobook.com/ is awesome.
garrow
that method of leaving comments on individual paragraphs is a neat trick.
gaoshan88
+19  A: 

PHP - far and away the most useful documentation i've ever seen.

It makes it very easy to find out new functionality of the language and very quickly understand how to use it, when to use it, when NOT to use it and what you should perhaps use instead. The user-contributed notes on each page often give insights into other interesting ways to use the function.

nickf
The user comments are often very helpful!
Rich
@nickf: Can you please add a link? Were you referring to this? http://www.php.net/manual/en/
Lernkurve
+4  A: 

jQuery Core. It's complete with tons of examples.

John Sheehan
For the core. The docs for the plugins --- even the "official" plugins, like "UI" are quite lacking.
James Curran
Oh absolutely correct
John Sheehan
+4  A: 

MSDN definitely is the best documentation out there. They have most of their technologies documented and most of the times they show you examples and code snippets and not just the reference. I believe that is one of microsoft strengths.

Django also has good documentation and quite simple. Very Ad-hoc to the framework.

Gustavo Rubio
You should be more specific.The Platform SDK docs are decent but the .NET library docs are abysmal.
shoosh
Well most of the framework is quite well documented and they have good and easy to follow examples, SQL Server documentation is also very complete. Im not talking about quantity im talking about quality.
Gustavo Rubio
MSDN gives you the general information, but rarely provides you the specifics.
ARKBAN
MSDN's quality varies a lot -- some sections are very good, others most definitely are not.
Paul Lalonde
+3  A: 

TortoiseSVN has a really nice documentation.

Borek
A: 

ORACLE has excellent documentation.

Igor Drincic
I'd agree with this - don't know why anyone modded it down. It's well indexed, comprehensive and fairly easy to understand.
ConcernedOfTunbridgeWells
Oracle seems to have a lot of documentation, but I've never found it very easy to use. I can generally find the answer I need faster by Googling for it.
James Curran
+2  A: 

The Commodore-written documentation for the Amiga OS was superb. I learned probably 80% of what I apply today from those books and text files/AmigaGuides. The RKM Libraries Third Edition had probably the most cogent explanation of OO programming that I've written - understandable even to a 14-year old as (I think) I was then. Ah, happy days.

Link to online versions: http://pub.elowar.com/AmigaDev/

endian
+3  A: 

PostgreSQL has an excellent documentation, especially for all it's SQL syntax.

gizmo
A: 

Does paper documentation count?

Apple's old "Inside Macintosh" series is, by and large, the best set of written docs I've ever read.

Yes, I have the white hair to prove that I actually did read it :)

Paul Lalonde
+1  A: 

What kind of documentation are you looking for? If you're talking about API documentation, Java makes it easy to generate really good documentation via javadoc. People generally fail to take advantage of it though.

Anyway, I usually look at the following when trying to figure out appropriate conventions (grammar style, levels of details etc):

  1. Java SE - http://java.sun.com/javase/6/docs/api/
  2. Spring Framework - http://static.springframework.org/spring/docs/2.5.x/api/index.html
Jack Leow
+1  A: 

Some of the best documentation I've ever seen is in the CodeIgniter project. The whole API is outlined with examples along the way, and the user interface is incredible. They really took their time making it presentable.

http://codeigniter.com/user_guide/

Not to mention the Wiki and the forums. With those added in, what else could you ask for?

Josh Sandlin
+2  A: 

sqlite is often touted as having the best documentation ever, and it's really true.

Rich
A: 

I learned SQL from the MySQL documentation. I'd say it's the best documentation I've ever read.

antik
A: 

So many shares the view that The TexBook by Donald Knuth is the best software documentation ever.

Vijay Mathew