RE: Developer "Best Practices" content

Subject: RE: Developer "Best Practices" content
From: Ben Davies <bdavies -at- imris -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: Tue, 12 Jun 2012 20:11:13 +0000

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

Why was the tips and tricks page just "go away" after you were asked to update it? From what you said, it sounds like it was a maintenance hassle. Was it deemed that the customer no longer needed this information? Because to me, that is the ONLY thing that really matters.

Personally, I would rather have (see "kill for") a one page summary (cheat sheet) that helped me understand the stack of books in front of me, instead of being forced to read the entire stack of books to figure something out..

Ben






This email has been scanned by the IMRIS Email Security System

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

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

Previous by Author: RoboHelp 9 glossary problem
Next by Author: RE: Bullet Styles
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