Re: Developer wants to take over documentation

Subject: Re: Developer wants to take over documentation
From: Estella Clifford <cliff -at- FP -dot- COM>
Date: Tue, 29 Apr 1997 17:56:18 EST

In reply to:
>
>Have any of you ever encountered a developer who wanted to take over
the
>documentation?

<snipped>

Well, in my experience, they usually don't *volunteer* to do
documentation unless the alternative is even more unpleasant. . .
but I recently had to hand off a doc to a developer for at least some of
the work, due to time and resource constraints.

Off the top of my head, I suggest:

- make sure everyone is on the same wavelength, as far as notation
conventions, style sheets (templates?), tools and terminology are
concerned.

- make sure everyone backs up their work.

- make sure the resulting files are kept secure, yet available to
whoever is co-ordinating production, etc.

- remind them of who the audience is; this is especially important
(IMHO) if techies are going to be documenting a product for
end-users who are not necessarily techies.

Good luck!

Estella

(clifford -at- fp -dot- com)

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: fixchp utility
Next by Author: Re: Document Management Tools
Previous by Thread: Re: Developer wants to take over documentation
Next by Thread: Re: Developer wants to take over documentation


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

Sponsored Ads


Sponsored Ads