Re: Documentation Metrics

[Paul Jones <pjones@metalab.unc.edu>]

David and company,
why not take a look at the OMF (open source document metadata
framework) that we developed this summer? it uses dublin core (and
RDF) compliant fields, allows for user creation of metadata (or by experts
such as your self ;->), searching and separation of the metadata from the
documents (as in a card catalog and a book, say). we've just been meeting
with eric miller of the RDF project (and late of Dublin Core) and it looks
like we can have interoperability with Rufus, the RMP RDF-based search
engine as well.
at the open source documentation summit in monterey this summer, folks
from several open source doc projects gave us their approval and the
docbook guy, oops i forget his name just now, is talking about integrating
the metadata in to docbook (from which it could be extracted if desired).

for more see http://www.ibiblio.org/osrt/omf/


On Mon, 16 Oct 2000, David C. Merrill, Ph.D. wrote:

+I am working on the set of metrics to be used in reviewing our documents.
+Here is what I've come up with so far. Please send me your suggestions to
+improve this. I have had one person volunteer to help me with this process
+so far (thanks Nelson), and would like to have at least 2 more volunteers.
+
+1. Audience Type
+- application user
+- programmer
+- system administrator
+
+2. Audience Technical Sophistication
+- novice
+- beginner
+- intermediate
+- advanced
+
+3. Accuracy
+- awful
+- poor
+- fair
+- good
+- excellent
+
+4. Comprehensiveness
+- sketchy (a few bare facts)
+- adequate (good amount of information)
+- comprehensive (complete coverage of the subject)
+
+5. Source Format
+- DocBook SGML
+- DocBook XML (none currently, I think)
+- LinuxDoc SGML
+- HTML
+- text
+- texinfo
+- whatever else you find
+
+6. Style
+- obtuse
+- readable
+- accessible
+
+7. Language (grammar and spelling)
+- awful
+- poor
+- fair
+- good
+- excellent
+
+8. General Information
+- author's name and email
+- current maintainer's name and email, if different from the author
+- version, if there is one
+- date of last update
+
+9. Currency
+- badly out of date
+- slightly out of date
+- up to date
+
+I would like to assemble this information into a spreadsheet that I can work
+with, and I am planning on using Gnumeric for this.
+
+Once I have this basic information assembled for each document, I will know
+the areas that need the most work. Then, I'll start by dealing with the
+worst problems first.
+
+I would appreciate any suggestions on how I might approach this better.
+
+--
+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
+
+

==========================================================================
                             Paul Jones
                    "Gort! Klaatu barada nikto!"
http://www.ibiblio.org/pjones/ at the Site Formerly Known As MetaLab.unc.edu
  pjones@ibiblio.org   voice: (919) 962-7600     fax: (919) 962-8071 
===========================================================================


--  
To UNSUBSCRIBE, email to ldp-discuss-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org