[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: thanks to jmc@ for all the MAN page work



On Wednesday 31 December 2003 22:06, Chuck Yerkes wrote:
> (and monday, my group at work replaces a (left the co) SA with
> a tech writer under the notion that instead of us spending 2 days
> writing bad docs, he can do it in 1/2 day so we all have more
> time and better docs in the end.  wheeee).

I'm sorry to disabuse you of this notion of you spending less time on 
documentation, unless you don't want to take advantage of a tech writer's 
skills. In this I assume that documentation in the sense of manuals/user 
guides, and of course, the source code is properly documented.

A tech writer needs, in general, to know what you are doing, as well as 
understand enough (technically) what you are doing in order to write 
comprehensible documentation.  This implies _communication_, and needless to 
say, this does take time. 

/Sigfred



Visit your host, monkey.org