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.
Summary of Responses: What to call a guide to an SDK
Subject:Summary of Responses: What to call a guide to an SDK From:Peter Kelly <Peter_Kelly -at- baan -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 30 Nov 1999 11:31:30 -0500
Thanks to all who sent suggestions on what to call a guide shipped with a
software developer's kit.
Quite a few people rightly pointed out that the documentation accompanying
an SDK is part of the SDK and not the SDK itself, which is made up of the
documentation plus software components.
For Tom Murrell, yes the wording of my question was a bit confusing--mea
culpa. I am not advocating that documentation be done away with for an
SDK--the one I am documenting is far from *intuitive*. I was trying to say
that the only indication of how to use the SDK can come from the
documentation that accompanies the SDK since the SDK is a collection of
software components with no user interface, so why not call the doc "SDK."
But the responses I received from the good people on this list have shown
that developers most have come across do expect the documentation
accompanying an SDK to be called something other than SDK.
Here is what tech whirlers have proposed. Numbers after the title proposed
indicate the number of people who proposed that title.
SDK Guide 1
SDK User Guide 1
Programmer's Guide to the SDK 2
SDK User's Guide 2 (one writer said that this is the name their customers
SDK User's Manual 1
SDK Guide (the writer who submitted this said that 7 developers unanimously
chose this title)