Re: SDK documentation

Subject: Re: SDK documentation
From: Carrie Baker <carriebak -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 28 Jul 2005 20:05:54 +0200


Thanks, this is very helpful, now I know what additional info to ask
the programmer for.

On 7/28/05, David Castro <thejavaguy -at- gmail -dot- com> wrote:
> On 7/28/05, Carrie Baker <carriebak -at- gmail -dot- com> wrote:
> > > If I was to go to a SDK User Guide and find the same material in there
> as in the Javadoc (or the equivalent that you're creating), I would be
> rather annoyed. I expect the SDK User Guide to have more information
> on the SDK than datatypes, method signatures, and class hierarchies. I
> expect it to have an explanation on when to use the HierarchicalTable
> versus the TreeTable, to have example code for each
> component/method/data structure, and to talk about how each of the
> things can fit together. That kind of information is what really makes
> a product's SDK useful.
>
> In fact, while there isn't a hard-and-fast rule as to what separates
> an "API" from a "SDK," in my opinion, what I describe is an SDK, where
> what you were provided (likely) is an API. I'll caveat that by saying
> that the developer may have embedded the features that I discussed in
> the HTML file that he provided you...though I'd be surprised!
>
> -David Castro
> thejavaguy -at- gmail -dot- com
>


--
Carrie Baker
carriebak -at- gmail -dot- com

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

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



References:
SDK documentation: From: Carrie Baker
Re: SDK documentation: From: David Castro

Previous by Author: SDK documentation
Next by Author: Best machine translation software
Previous by Thread: Re: SDK documentation
Next by Thread: SDK documentation?


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


Sponsored Ads