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