HOWTO Document and Write an SDK?

jmwmit asks: "A startup that I am working with is looking to write its first SDKs - one public for community developers and one for 3rd party commercial developers. What is the Slashdot recommended or preferred format for SDK documentation, both the code APIs and the general docs? What great SDK examples have people used in the past and would recommend as good models? What do Slashdot developers consider absolutely necessary features in an SDK, regardless of the application?"

Comments

Qt

[Otter]

TrollTech did a superb job with Qt. Excellent balance of documentation, examples, tutorials and overviews.

Re:Slashdot standards?

[oojah]

I felt this needed highlighting:

I'm tired of reading documentation that's written like I already understand the system and only makes sense after you know what you're doing. If I already understood the system I wouldn't need docs.

It's an excellent point - don't just document your API, tell us how to use it!

Cheers,

Roger