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.
Subject:What to call a guide accompanying an SDK? From:Peter Kelly <Peter_Kelly -at- baan -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 29 Nov 1999 17:30:44 -0500
Hello people,
What would you call a guide or manual accompanying a software
developer's kit? Can you have a guide to a kit? Does that not seem strange?
The kit is a bunch of software components intended for developers so that
they can whip out applications fast. I thought that the guide was the "kit"
itself, since the components to be distributed in the SDK do not have any
sort of documentation or user interface and the only indication one could
get on how to use the "kit" was from the documentation--so why not call it
the "SDK". The guide will contain an API, instructions for testing
components developed with the SDK etc. There are those in my midst who
prefer to call the documentation to be provided "The Programmer's Guide to
the SDK" or some such. Please suggest alternatives. This is probably not of
interest for most so please reply offline. I will summarize if anyone
expresses an interest.
