Re: [gnome-love] Computing readability values in gtk-doc



On Wed, Jun 27, 2001 at 01:54:11AM -0400, Daniel Veillard wrote:
  While reading the recently added usability and readability guide

  http://developer.gnome.org/documents/usability/

I found that some of the readbility tests could probably be computed
without too much troubles in an automated way. There is 3 algorithm
provided at 

   http://developer.gnome.org/documents/usability/usability-readability.html

Computing those (or grabbing existing code to do so) and linking it to
gtk-doc could help making some systematic evaluation of our documentation.
I already appreciated a lot the improvement in gtk-doc providing the
coverage percentage of the docs, I think adding more metrics would be
useful (and it sounds like a fun thing to add).

  Hum, telsa seems to have found existing related tools 

---------------------
From: Telsa Gwynne <hobbit aloss ukuu org uk>
To: gnome-doc-list gnome org
Subject: Re: documentation usability
On Wed, Jun 27, 2001 at 01:30:26AM -0400 or thereabouts, Daniel Veillard wrote:
On Tue, Jun 26, 2001 at 09:39:41PM -0600, John Fleck wrote:

http://developer.gnome.org/documents/usability/

  The readability tests are interesting because they look automatable,
it should not be too hard to do automatically on the docbook documents.

I read an article last year about this kind of thing and grabbed the
GNU tools for checking articles: 

The article is:
http://linux.oreillynet.com/pub/a/linux/2000/05/05/LivingLinux.html
http://linux.oreillynet.com/pub/a/linux/2000/05/05/LivingLinux.html?page=2

It cleverly doesn't mention where to get 'diction' and 'style' but I
got them from:

http://www.gnu.org/software/diction/diction.html

(Both in the same tarball)

Telsa
---------------------

  So it might just be a question of integrating them with gnome-doc

Daniel

-- 
Daniel Veillard      | Red Hat Network http://redhat.com/products/network/
veillard redhat com  | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/
Sep 17-18 2001 Brussels Red Hat TechWorld http://www.redhat-techworld.com




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