Date: Fri, 16 Mar 2001 19:56:38 -0800 From: "Ted Mittelstaedt" <tedm@toybox.placo.com> To: "David Johnson" <djohnson@acuson.com> Cc: <freebsd-questions@FreeBSD.ORG> Subject: RE: documentation issues generally Message-ID: <000401c0ae96$44c0fe40$1401a8c0@tedm.placo.com> In-Reply-To: <3AB25AA3.CFD6AC22@acuson.com>
next in thread | previous in thread | raw e-mail | index | archive | help
>-----Original Message----- >From: David Johnson [mailto:djohnson@acuson.com] > >It's not that they consider it "wasting time", it's just that it's pure >drudgery. I've written documentation for my own programs, and am >currently helping with docs for KDE. It's not fun. It's boring. The >developers should be the ones writing the docs, since they know the >software the best, but they will probably be the ones least likely to Ah, but there's more to writing docs than just knowing the material. The other part is getting that material across. Docs written by someone who only knows the material best but is unable to effectively get the point across are just as bad as docs written by someone who may be able to communicate but doesen't know the material. If the developer can't communicate effectively, they shouldn't be the ones documenting the software. Ted Mittelstaedt tedm@toybox.placo.com Author of: The FreeBSD Corporate Networker's Guide Book website: http://www.freebsd-corp-net-guide.com To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-questions" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?000401c0ae96$44c0fe40$1401a8c0>