discuss: the good the bad and the ugly
Subject:
Re: the good the bad and the ugly
From:
Tabatha Marshall ####@####.####
Date:
19 Nov 2003 03:12:47 -0000
Message-Id: <1069211538.4047.62.camel@mysticchild>
On Tue, 2003-11-18 at 19:04, David Horton wrote:
> What are the criteria for "good docs"? Is it anything not outdated or
> is content being judged as well?
I suppose any answer would be somewhat subjective, but here goes... :D
I would say anything that has been technically reviewed for accuracy,
reviewed for language (spelling, grammar, clarity), contains links for
readers to get more information, shows alternative methods to accomplish
the task, if available (depending on the scope), and clearly meets the
defined scope, would be indicative of a "good" doc.
In other words, if you tell us we can do something by the end of the
HOWTO, we better be able to do it! :D
Again, subject to opinion. There are many components that make up a
good document. The above are some of the things I consider criteria for
a work being submitted.
Tab
--
Tabatha Marshall
Web: www.merlinmonroe.com
Linux Documentation Project Review Coordinator (http://www.tldp.org)
Linux Counter Area Manager US:wa (http://counter.li.org)
