Re: About The Cloud: Quick-Read Suggestions

Subject: Re: About The Cloud: Quick-Read Suggestions
From: "Weissman, Jessica" <WeissmanJ -at- abacustech -dot- com>
To: "salt -dot- morton -at- gmail -dot- com" <salt -dot- morton -at- gmail -dot- com>
Date: Wed, 3 Apr 2013 20:36:17 -0400

I hope that someone has defined the goals of the API documentation. API docs beyond the reference level may truly be intended to help new developers, or they may be primarily a marketing tool to establish credibility. Often, experienced developers just look at the examples. So make sure to include interesting and useful examples in the API docs.

If your developers haven't used one of the automated API creation tools, you will have to do a lot of spadework getting basic information out of them. My best investment was a box of random treasures from Archie McPhee. Developers who claimed to be too busy to blow their own noses would talk to me for the chance to pick an irony-laden geek toy from my box of plastic stuff. It helps, of course, to bother them as little as possible and to ask the smartest questions you can.

Writing API dos and doing an SDK was one of the most fun and most frustrating tasks I've taken on in my entire career.

- Jessica
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>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


Follow-Ups:

References:
About The Cloud: Quick-Read Suggestions: From: Chris Morton
Re: About The Cloud: Quick-Read Suggestions: From: Ryan Pollack
Re: About The Cloud: Quick-Read Suggestions: From: Chris Morton

Previous by Author: Re: About The Cloud: Quick-Read Suggestions
Next by Author: RE: Need a collective noun
Previous by Thread: Re: About The Cloud: Quick-Read Suggestions
Next by Thread: Working with developers (was Re: About The Cloud: Quick-Read Suggestions)


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

Sponsored Ads


Sponsored Ads