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.
I would recommend against volunteering to write and format developer docs.
Presumably your job is to write and publish customer documentation, which has (or
should have) a completely different focus from developer documentation.
You don't want your focus on producing information to help users work effectively
with your product to get pushed aside while you do developers' work.
Product managers should own the requirements specs -- what the product should
do. Developers should own the design specs -- what the product actually does and
how it does it.
Make the case that developer documentation is important for building a
high-quality product on time - not simply as a source of information for customer
docs.
Scott
Jean Weber wrote:
> If you offer to do the rewriting and formatting of the developer docs, the
> developers might decide that you save them more time than it takes to
> explain a few things to you. And, as always, use the approach that what you
> do makes _them_ look good.
>
> Regards, Jean
> Jean Hollis Weber
--
Scott Wahl
Customer Documentation and Training
Bridgewater Systems Corporation
(613) 591-6655 x.2579
