Interactive docs vs static reference

[Abhijeet]

Hi,

There is a trend towards interactive documentation using swagger, I/o docs, API console, etc. Alternatively, there is a school of thought that static API reference is better experience and interactive though "cool" is counter- intuitive for developers. I will like to poll the community for their thoughts, preferences or recommendation on static vs interactive documentation.

Thanks for the help.

Cheers
Abhijeet

[Ted M. Young [@jitterted]]

Hi Abhijeet,

Are these options mutually-exclusive? Since (after a cursory look) these are automatically generated, why not offer both? Personally, API docs are necessary, but not sufficient. A good set of examples (e.g., a cookbook) is really important for developers to understand how APIs work together.

;ted
--
Ted M. Young
Polyglot Software Developer and eXtreme Programmer
http://about.me/tedmyoung

Abhijeet

--
You received this message because you are subscribed to the Google Groups "API Craft" group.
To unsubscribe from this group, send email to api-craft+...@googlegroups.com.
Visit this group at http://groups.google.com/group/api-craft?hl=en.