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.
Subject:Writing documentation for other tech writers From:"Sella Rush" <srush -at- MusicNet -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 22 Mar 2002 22:00:09 -0800
For anyone doing backend/SDK documentation, have you ever written materials for the tech writers who'll be documenting the end product?
For example, I'm writing SDK docs for a backend system. Other people will be developing client GUIs that access our system, and presumably there will be tech writers documenting those GUIs. There are many issues about the backend system that will impact the end user, and it is in our best interest to make sure that information is communicated accurately and thoroughly.
So I'm thinking it would be useful to include something (a section in the SDK? a simple FAQ?) that's written directly to their documentation team. This document would be a repackaging of existing information, laying out hot issues and explaining the ramifications, rather than forcing those tech writers to wade through the developer-targeted material--or more likely relying on their dev staff to trickle the information down.
Advantages include faster/less resource-intensive ramp up time for their writing and dev staff (in my case this is also good for us), lower impact on customer service (happier customers). Both end up reflecting well on the quality of the SDK/backend product.
If you document apps written to third-party SDKs, what do you think? Have you seen something like this and found it useful/useless? I'm thinking of this as a useful resource, which, come to think of it, could also serve to help their customer service staff.
Just some thoughts.
srush -at- musicnet -dot- com
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at http://www.ehelp.com/techwr
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.