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.
> An inhabitant of a corner office has decided that our documentation
> lacks a page or section that would be Best Practices for programmers
> using our SDK.
> From my point of view, the entire SDK docs are what a
> customer/developer might want to know.
Dittos to Erika and Chris. IME, developers like to see examples. Lots of examples. Code snippets for adding a widget, deleting a widget, retrieving the widget configuration, changing the widget configuration, etc., with text explanations of why you do x before y, etc.
In addition, the API should ideally include a complete, compilable sample application that illustrates some simple use case from beginning to end. If it's there, a significant number of your customers will use the sample app as the starting point for their own app.
Richard G. Combs
Senior Technical Writer
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.