TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
On 7/28/05, Carrie Baker <carriebak -at- gmail -dot- com> wrote:
> The programmer is working in C++ and has created an html file that is
> automatically generated, listing all of the classes and commands, what
> they are comprised of and what they do. (I have checked the English).
>
> Do I need to copy all of this information to also create a PDF file
> (my source would be Frame for this) so there will be an "SDK User
> Guide", or is the integrated html considered sufficient?
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!
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.
