Re: Developer Documentation

Subject: Re: Developer Documentation
From: Scott Wahl <swahl -at- BRIDGEWATERSYS -dot- COM>
Date: Tue, 23 Mar 1999 08:26:36 -0500

Hi all,

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


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

From ??? -at- ??? Sun Jan 00 00:00:00 0000=

Previous by Author: Re: Am I an illustrator or a writer?
Next by Author: Re: Writing Specifications
Previous by Thread: Re: Developer Documentation
Next by Thread: Re: Developer Documentation

What this post helpful? Share it with friends and colleagues:

Sponsored Ads