<div dir="ltr">Hi all, <br>I just found this article about how developers use API documentation. What I found is the authors of the article used a Google Chrome extension called DocSight to get the insights they did. I wonder if we could request that OpenStack REST API consumers use this extension? It would offer valuable insight. Do you think people would be willing to run this and give us the data? <br>


<br>
Link to full article below this snippet: <br>
<br>
The YouTube API recently moved their official developers support from Google Groups to Stack Overflow (<a href="https://rackermail.rackspace.com/owa/redir.aspx?C=1nE3DNGFY0-6bZ9UxmIqE46y_Boy-M8IxdsJLUf3XFmcqGh3kyFh0NEXOvXh9jixiKByp9lzFdE.&URL=http%3a%2f%2fapiblog.youtube.com%2f2012%2f09%2fthe-youtube-api-on-stack-overflow.html" target="_blank">Move</a>)—

 relying on a few thousand questions about the API and on mechanisms of 
Stack Overflow. And there is no sign in sight that documentation is all 
the sudden going to get better.
<h2 id="developers-revolt">Developers revolt</h2>
<p>Instead, developers have been indirectly documenting APIs themselves through a process called
<a href="https://rackermail.rackspace.com/owa/redir.aspx?C=1nE3DNGFY0-6bZ9UxmIqE46y_Boy-M8IxdsJLUf3XFmcqGh3kyFh0NEXOvXh9jixiKByp9lzFdE.&URL=http%3a%2f%2fblog.ninlabs.com%2f2012%2f05%2fcrowd-documentation%2f" target="_blank">
crowd documentation</a>, by publishing blog posts and curating questions
 and answers about APIs. We previously found that even without any 
inherent coordination, a crowd of Android developers can cover as much 
as 88% of the API classes in discussions on Stack
 Overflow.</p>
<p>We collected 1,316 days of Android developer history (average 11 weeks per developer) and we found 9,234 visits to
<a href="https://rackermail.rackspace.com/owa/redir.aspx?C=1nE3DNGFY0-6bZ9UxmIqE46y_Boy-M8IxdsJLUf3XFmcqGh3kyFh0NEXOvXh9jixiKByp9lzFdE.&URL=http%3a%2f%2fstackoverflow.com" target="_blank">
stackoverflow</a>, as well as 2,547 to <a href="https://rackermail.rackspace.com/owa/redir.aspx?C=1nE3DNGFY0-6bZ9UxmIqE46y_Boy-M8IxdsJLUf3XFmcqGh3kyFh0NEXOvXh9jixiKByp9lzFdE.&URL=http%3a%2f%2fdeveloper.android.com" target="_blank">
developer.android.com</a>, which hosts the official documentation for 
Android. We also analyzed the code examples that could be found in the 
Stack Overflow data dump and
<a href="https://rackermail.rackspace.com/owa/redir.aspx?C=1nE3DNGFY0-6bZ9UxmIqE46y_Boy-M8IxdsJLUf3XFmcqGh3kyFh0NEXOvXh9jixiKByp9lzFdE.&URL=http%3a%2f%2fdeveloper.android.com%2fguide" target="_blank">
developer.android.com/guide</a>.</p>
<h4 id="in-our-new-study-we-find-that">In our new study, we find that:</h4>
<ul><li>Developers may be getting as much as 50% of their documentation from Stack Overflow.</li><li>More examples can be found on Stack Overflow than the official documentation guide.</li><li>In web searches, Stack Overflow questions are visited 2x-10x more often than official documentation.</li>

</ul>
<h4 id="we-also-found-some-interesting-patterns-of-web-browsing-behavior">We also found some interesting patterns of web browsing behavior:</h4>
<ul><li>Developers directly browse official documentation in intermittent bursts.</li><li>Some developers learn APIs through “apprenticeships” with expert Stack Overflow users.</li><li>Developers continously reference Stack Overflow questions during development via search.</li>

</ul>
<br>
<a href="https://rackermail.rackspace.com/owa/redir.aspx?C=1nE3DNGFY0-6bZ9UxmIqE46y_Boy-M8IxdsJLUf3XFmcqGh3kyFh0NEXOvXh9jixiKByp9lzFdE.&URL=http%3a%2f%2fblog.ninlabs.com%2f2013%2f03%2fapi-documentation%2f" target="_blank">http://blog.ninlabs.com/2013/03/api-documentation/</a><br>

</div>