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