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.
SDK: Short for software development kit, a programming package that enables
a programmer to develop applications for a specific platform. Typically an
SDK includes one or more APIs, programming tools, and documentation.
Or then of course somone mentioned Gordon & Gordon's
course on writing API docs, here's a quick summary they
did for the STC:
Question: What is the difference between an application programming
interface and a software development kit?
Answer: Documentation, mostly.
> No, your statement that "an SDK is an API with docs" is completely
> There is a big difference between a SDK (software development kit) and
> an API (application programming interface). The former allows you to
> develop applications. The latter allows you to leverage third party
> functionality via function calls into a 3rd party component from
> within the application you're developing. The two are very, very
Look, I don't want to be all defensive, but this is misleading. You develop
applications by making calls to third party libraries; e.g., WIndows,
OpenGL, etc. Whether they are "third party" or related to the operating
is not relevant to whether something is an API or an SDK. Likewise there's
no reason why a compiler or IDE that a programmer uses has to be supplied
by the same people as the operating system, hardware, or multiple third
APIs. An SDK is _not_ the same as a programming environment / compiler /
IDE. Which is not to say that an SDK wouldn't have to include some
compilation tools if it were not compiled as a set of libraries that can
be linked to directly on the developer's intended platform (which I think is
what Susan Gallaghers piece is trying to say).
I think there are enough angels on this particular pin now.
Christopher Gooch, Technical Author
LightWork Design, Sheffield, UK.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
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.