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:Re: What to call a guide accompanying an SDK? From:Janet_Swisher -at- trilogy -dot- com To:techwr-l -at- lists -dot- raycomm -dot- com Date:Tue, 30 Nov 1999 15:20:06 -0600
I don't see any problem with calling it the "Product Name SDK Programmer's
Guide". Or, if the components are so easy to put together that you don't
even need to be a programmer to use them, you could call it the "Product
Name SDK Developer's Guide". (This is per the MS Manual of Style.) If
both of those sound too intimidating, you could go with just "Product Name
SDK Guide", as Leslie suggested.
The guide is not the kit. The software components, plus the
documentation, are the kit. Think about building a "kit car" -- you get a
bunch of parts to put together, and a guide that tells you how to do it.
Neither one alone is sufficient.
