Account Options

  1. Sign in
The old Google Groups will be going away soon, but your browser is incompatible with the new version.
Google Groups Home
« Groups Home
API Craft
Home
+ new post
About this group
Join this group
Interactive docs vs static reference
Options
There are currently too many topics in this group that display first. To make this topic appear first, remove this option from another topic.
There was an error processing your request. Please try again.
flag
   2 messages - Collapse all  -  Translate all to Translated (View all originals)
The group you are posting to is a Usenet group. Messages posted to this group will make your email address visible to anyone on the Internet.
Your reply message has not been sent.
Your post was successful
 
From:
To:
Cc:
Followup To:
Add Cc | Add Followup-to | Edit Subject
Subject:
Validation:
For verification purposes please type the characters you see in the picture below or the numbers you hear by clicking the accessibility icon. Listen and type the numbers you hear
 
Abhijeet  
View profile  
 More options Oct 28 2012, 1:04 pm
From: Abhijeet <ranad...@gmail.com>
Date: Sun, 28 Oct 2012 10:04:27 -0700 (PDT)
Local: Sun, Oct 28 2012 1:04 pm
Subject: Interactive docs vs static reference
Print | Individual message | Show original | Report this message | Find messages by this author

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


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
Ted M. Young [@jitterted]  
View profile  
 More options Oct 28 2012, 1:37 pm
From: "Ted M. Young [@jitterted]" <tedyo...@gmail.com>
Date: Sun, 28 Oct 2012 10:36:59 -0700
Local: Sun, Oct 28 2012 1:36 pm
Subject: Re: [api-craft] Interactive docs vs static reference
Print | Individual message | Show original | Report this message | Find messages by this author

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


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
End of messages
« Back to Discussions « Newer topic     Older topic »

Create a group - Google Groups - Google Home - Terms of Service - Privacy Policy
©2013 Google