RE: Developer "Best Practices" content

Subject: RE: Developer "Best Practices" content
From: "Combs, Richard" <richard -dot- combs -at- Polycom -dot- com>
To: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 11 Jun 2012 09:02:26 -0700

McLauchlan, Kevin wrote:

> 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
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-903-6372
------









^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Developer "Best Practices" content: From: McLauchlan, Kevin

Previous by Author: Re: Surveying Your Customers
Next by Author: RE: Frame 7/Robo X5 with Windows 7?
Previous by Thread: RE: Developer "Best Practices" content
Next by Thread: RE: Developer "Best Practices" content


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads