Developer "Best Practices" content

Subject: Developer "Best Practices" content
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 10 Jun 2012 19:24:16 -0400

This is for list members who document software/hardware/firmware products where a customer might be expected to program an app that uses your product, or to integrate your product into a third-party application.
In other words, with your product you supply a developer's toolkit.

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.

Some years ago, that portion of the docs included a Tips and Tricks page until I was asked to remove portions that had become outdated. The whole thing went away.

I see no need - and I think even corner-office would agree - for material that any programmer should already know or can find in an O'Reilly book (do they still publish those?), in a C# for Dummies or a Java for Dummies book or similar.

Our headers and sample code are as standardized as we can make them, and include comments relevant to each major language that we support, so there's nothing additional to say about compile options, etc.

What do y'all do on this topic?


- k


The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.



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


Follow-Ups:

Previous by Author: documenting in the cloud (was RE: Back on topic please
Next by Author: RE: TECHWR-L Digest, Vol 80, Issue 10
Previous by Thread: Re: alphabetizing php array in WordPress ?
Next by Thread: Re: Developer "Best Practices" content


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

Sponsored Ads


Sponsored Ads