Re: API - Suggestions on Document

Subject: Re: API - Suggestions on Document
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 24 Apr 2012 01:15:32 -0700 (PDT)

Architecture
Integration
Performance capabilities and bottlenecks
Protocols
Language bindings
Depth and breadth of API exposure

Not to mention the quality of the SDK (as something over and above the API, I might add).  Decision makers consider these things.  If the sale of the product depends on its API, then you need to reach the decision makers.

On Fri, Apr 20, 2012 at 4:27 PM, Robert Lauriston <robert -at- lauriston -dot- com> wrote:
> I still don't get why an end user would need to know anything about an
> API other than *what* it can be used for, which is typically a bullet
> list.
>
> Why would anyone other than programmers need a diagram of *how* an API
> works? I don't see the business case for creating such a document.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

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

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


Previous by Author: Re: Interviewing technical writers
Next by Author: Re: Source control software recommendations for doc team
Previous by Thread: RE: API - Suggestions on Document
Next by Thread: Re: The Whatchamacallit


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

Sponsored Ads


Sponsored Ads