Re: Examples of well-documented APIs and SDKs?

Subject: Re: Examples of well-documented APIs and SDKs?
From: Ryan Pollack <ryan -at- clicksecurity -dot- com>
To: Lois Patterson <loisrpatterson -at- gmail -dot- com>
Date: Wed, 3 Apr 2013 14:28:43 -0500

Kinda buried in there is an article with some guidelines for creating
useful API docs: http://blog.parse.com/2012/01/11/designing-great-api-docs/

There are some examples (Stripe, GitHub, Backbone.js, Mailgun) mentioned
in-line.

-R


On Wed, Apr 3, 2013 at 2:26 PM, Ryan Pollack <ryan -at- clicksecurity -dot- com> wrote:

> Here is a bunch: https://github.com/PharkMillups/beautiful-docs
>
>
> On Wed, Apr 3, 2013 at 2:21 PM, Lois Patterson <loisrpatterson -at- gmail -dot- com>wrote:
>
>> Does anyone have some examples of well-documented APIs and SDKs, perhaps
>> in
>> open-source software or downloadable trials?
>>
>>
>> Lois Patterson
>> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>> From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help
>> sample with DISQUS for user commenting?
>>
>> Learn more: http://bit.ly/13xpg5n
>>
>> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>>
>> You are currently subscribed to TECHWR-L as ryan -at- clicksecurity -dot- com -dot-
>>
>> To unsubscribe send a blank email to
>> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>>
>>
>> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>> http://www.techwhirl.com/email-discussion-groups/ for more resources and
>> info.
>>
>> Looking for articles on Technical Communications? Head over to our
>> online magazine at http://techwhirl.com
>>
>> Looking for the archived Techwr-l email discussions? Search our public
>> email archives @ http://techwr-l.com/archives
>>
>
>
>
> --
>
> Ryan Pollack
> Senior Technical Writer | Click Security
>



--

Ryan Pollack
Senior Technical Writer | Click Security
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help sample with DISQUS for user commenting?

Learn more: http://bit.ly/13xpg5n

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Examples of well-documented APIs and SDKs?: From: Lois Patterson
Re: Examples of well-documented APIs and SDKs?: From: Ryan Pollack

Previous by Author: Re: Examples of well-documented APIs and SDKs?
Next by Author: Re: About The Cloud: Quick-Read Suggestions
Previous by Thread: Re: Examples of well-documented APIs and SDKs?
Next by Thread: Copy/paste table formatting in Word?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads