Developer Documentation

Subject: Developer Documentation
From: Tony Rocco <trocco -at- ONDISPLAY -dot- COM>
Date: Mon, 22 Mar 1999 12:29:29 -0800

Dear fellow tech writers,

I work in a pretty dynamic startup environment where developer documentation
like requirements specifications, functional specs, design documents, use
cases and things of that sort have been virtually non-existent. To compound
the problem, it can also be less than easy to get detailed explanations by
interviewing developers because everyone is short on time.

There are a few of us now trying to put some method to our madness in an
effort to get the information we need to do our jobs better. (This includes
documentation and QA.) We are working with a particular developer who is
keen on seeing a more methodical and orderly design process put into effect,
which would include more and better developer documentation. We are
discussing what developer documentation should look like so that we get the
information we need without imposing so many new documentation requirements
on developers that they will balk at writing them.

Thus, I am wondering what kinds of developer documents tech writers are most
familiar working with and find the most useful. Thanks for your help.

- tgrrr

Enlightenment is to be intimate with all things; it is the practice of
moment to moment intimacy.

- Zen Master DogenEnlEasdlkfjpasld;fjas;ldf

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

Previous by Author: Re: Help! First TW job interview
Next by Author: Re: Web browser colours
Previous by Thread: Editing PCL Files
Next by Thread: Re: Developer Documentation

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

Sponsored Ads