187 lines
7.2 KiB
HTML
187 lines
7.2 KiB
HTML
<!-- MHonArc v2.5.0b2 -->
|
|
<!--X-Subject: Re: Documentation Metrics -->
|
|
<!--X-From-R13: Rnivq [reevyy <qpzreevyyNzvaqfcevat.pbz> -->
|
|
<!--X-Date: Tue, 17 Oct 2000 19:13:03 -0400 (EDT) -->
|
|
<!--X-Message-Id: 39ECDD8A.37E48D91@mindspring.com -->
|
|
<!--X-Content-Type: text/plain -->
|
|
<!--X-Reference: NLEDLEBJMAFNKPMOMPDEKEBDCAAA.cbuchek@linuxgruven.com -->
|
|
<!--X-Reference: 005801c0384f$cec60670$6401a8c0@nc.ehomecare.com -->
|
|
<!--X-Reference: 00101722515203.05150@charles -->
|
|
<!--X-Head-End-->
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
|
|
<html>
|
|
<head>
|
|
<title>Re: Documentation Metrics</title>
|
|
<link rev="made" href="mailto:dcmerrill@mindspring.com">
|
|
</head>
|
|
<body>
|
|
<!--X-Body-Begin-->
|
|
<!--X-User-Header-->
|
|
<!--X-User-Header-End-->
|
|
<!--X-TopPNI-->
|
|
<hr>
|
|
[<a href="msg04146.html">Date Prev</a>][<a href="msg04148.html">Date Next</a>][<a href="msg04146.html">Thread Prev</a>][<a href="msg04150.html">Thread Next</a>][<a href="maillist.html#04147">Date Index</a>][<a href="threads.html#04147">Thread Index</a>]
|
|
<!--X-TopPNI-End-->
|
|
<!--X-MsgBody-->
|
|
<!--X-Subject-Header-Begin-->
|
|
<h1>Re: Documentation Metrics</h1>
|
|
<hr>
|
|
<!--X-Subject-Header-End-->
|
|
<!--X-Head-of-Message-->
|
|
<ul>
|
|
<li><em>To</em>: <A HREF="mailto:ldp-discuss@lists.linuxdoc.org">ldp-discuss@lists.linuxdoc.org</A></li>
|
|
<li><em>Subject</em>: Re: Documentation Metrics</li>
|
|
<li><em>From</em>: David Merrill <<A HREF="mailto:dcmerrill@mindspring.com">dcmerrill@mindspring.com</A>></li>
|
|
<li><em>Date</em>: Tue, 17 Oct 2000 19:15:22 -0400</li>
|
|
<li><em>Old-return-path</em>: dcmerrill@mindspring.com</li>
|
|
<li><em>References</em>: <<a href="msg04125.html">NLEDLEBJMAFNKPMOMPDEKEBDCAAA.cbuchek@linuxgruven.com</a>> <<a href="msg04126.html">005801c0384f$cec60670$6401a8c0@nc.ehomecare.com</a>> <<a href="msg04140.html">00101722515203.05150@charles</a>></li>
|
|
<li><em>Resent-date</em>: Tue, 17 Oct 2000 19:13:03 -0400 (EDT)</li>
|
|
<li><em>Resent-from</em>: <A HREF="mailto:ldp-discuss@lists.debian.org">ldp-discuss@lists.debian.org</A></li>
|
|
<li><em>Resent-message-id</em>: <DVpvjD.A.rdD.E2N75@murphy></li>
|
|
<li><em>Resent-sender</em>: <A HREF="mailto:ldp-discuss-request@lists.debian.org">ldp-discuss-request@lists.debian.org</A></li>
|
|
<li><em>Sender</em>: dmerrill</li>
|
|
</ul>
|
|
<!--X-Head-of-Message-End-->
|
|
<!--X-Head-Body-Sep-Begin-->
|
|
<hr>
|
|
<!--X-Head-Body-Sep-End-->
|
|
<!--X-Body-of-Message-->
|
|
<pre>
|
|
jdd wrote:
|
|
>
|
|
> sorry, folks, but I think there is a problem.
|
|
>
|
|
> I'm unsure what this discussion is about.
|
|
>
|
|
> I think initially it was about knowing what documentation was lacking (to
|
|
> try to write it) and giving a help to beginners (initial writing guide)
|
|
|
|
This thread, "Documentation Metrics", is and has always been about
|
|
documentation metrics. The first sentence of the first message is "I am
|
|
working on the set of metrics to be used in reviewing our documents."
|
|
|
|
> if the goal is still of this kind, you can continue to fill pages and
|
|
> pages of mails if you want, I can't afford to read it all, but I trust you.
|
|
>
|
|
> but if you mean you are going to weight the HOWTO's to know if they are
|
|
> good or not an to grades authors on this base, I disagree absolutely.
|
|
>
|
|
> knowing if a howto is well written or not is of nearly no interest, at
|
|
> least as long as there are yet to be written howto's.
|
|
|
|
Quantity and quality are both important. It is better to have no HOWTOs
|
|
than to have HOWTOs that contain horribly wrong, misleading and
|
|
inaccurate information! Please understand that I am *not* saying this is
|
|
our situation. I think most of our HOWTOs are reasonably well written
|
|
and accurate.
|
|
|
|
> The only question is : is this howto usefull or not ? is the answer is
|
|
> yes, let it live.
|
|
>
|
|
> I don't think ldp is allowed to do any real metric on the documentation.
|
|
|
|
Allowed by whom?
|
|
|
|
> If you want really to have some kind of judgement on the howto's,
|
|
> enventually, you can set online a questionaire asking users: did you read
|
|
> the howto ? did you use it ? do you like it ? and that's all
|
|
|
|
This is also a good idea, and it has been discussed in another thread.
|
|
|
|
To say that we are trying to "judge" HOWTOs or their authors is to put a
|
|
very negative spin on it. What we are trying to do is to get a
|
|
manageable "snapshot" of the current state of the collection.
|
|
|
|
> is for no other reason, the only people able really to meter a howto is a
|
|
> people able to write it, and if so he should better work with the author
|
|
> than judge him...
|
|
|
|
Working with the authors is *exactly* what I intend to do. I hope to be
|
|
their friend and ally in producing the best possible documentation.
|
|
|
|
Once the survey of the collection is complete, we will then:
|
|
|
|
1. Contact authors whose works are obsolete or becoming out of date, and
|
|
ask them if they can update it. If they cannot do so because of lack of
|
|
time or something else, we will ask them to find a new maintainer, or
|
|
allow us to do so.
|
|
|
|
2. Find fluent speakers of English to correct grammatical and spelling
|
|
errors.
|
|
|
|
3. Possibly archive very obsolete HOWTOs somewhere, or at least make
|
|
sure they are marked clearly, so readers know that they apply only to
|
|
certain, older versions of software.
|
|
|
|
4. Continue our work to get all documents converted into DocBook.
|
|
|
|
And so on. Whatever problems we find, we will deal with as seems
|
|
required.
|
|
|
|
> anyway, try to keep short, trim most of the initial mail in yours
|
|
> answers... this thread become unreadable...
|
|
>
|
|
> and don't think I under estimate your work. I greatly appreciate all you
|
|
> there.
|
|
|
|
Thank you very much.
|
|
|
|
Regards,
|
|
|
|
--
|
|
David C. Merrill, Ph.D.
|
|
Linux Documentation Project
|
|
Collection Editor & Coordinator
|
|
www.LinuxDoc.org
|
|
|
|
|
|
--
|
|
To UNSUBSCRIBE, email to ldp-discuss-request@lists.debian.org
|
|
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
|
|
|
|
</pre>
|
|
|
|
<!--X-Body-of-Message-End-->
|
|
<!--X-MsgBody-End-->
|
|
<!--X-Follow-Ups-->
|
|
<hr>
|
|
<!--X-Follow-Ups-End-->
|
|
<!--X-References-->
|
|
<ul><li><strong>References</strong>:
|
|
<ul>
|
|
<li><strong><a name="04125" href="msg04125.html">RE: Documentation Metrics</a></strong>
|
|
<ul><li><em>From:</em> "Craig M. Buchek" <cbuchek@linuxgruven.com></li></ul></li>
|
|
<li><strong><a name="04126" href="msg04126.html">Re: Documentation Metrics</a></strong>
|
|
<ul><li><em>From:</em> "David C. Merrill, Ph.D." <dcmerrill@mindspring.com></li></ul></li>
|
|
<li><strong><a name="04140" href="msg04140.html">Re: Documentation Metrics</a></strong>
|
|
<ul><li><em>From:</em> jdd <jdanield@dodin.net></li></ul></li>
|
|
</ul></li></ul>
|
|
<!--X-References-End-->
|
|
<!--X-BotPNI-->
|
|
<ul>
|
|
<li>Prev by Date:
|
|
<strong><a href="msg04146.html">Re: Documentation Metrics</a></strong>
|
|
</li>
|
|
<li>Next by Date:
|
|
<strong><a href="msg04148.html">Re: List formatting in Docbook -> PDF/PS</a></strong>
|
|
</li>
|
|
<li>Previous by thread:
|
|
<strong><a href="msg04146.html">Re: Documentation Metrics</a></strong>
|
|
</li>
|
|
<li>Next by thread:
|
|
<strong><a href="msg04150.html">Re: Category Specialists (was Documentation Metrics)</a></strong>
|
|
</li>
|
|
<li>Index(es):
|
|
<ul>
|
|
<li><a href="maillist.html#04147"><strong>Date</strong></a></li>
|
|
<li><a href="threads.html#04147"><strong>Thread</strong></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<!--X-BotPNI-End-->
|
|
<!--X-User-Footer-->
|
|
<!--X-User-Footer-End-->
|
|
</body>
|
|
</html>
|