Helping your documentation effort. | sec=unclassified

Stoffers, Robert LAC Robert.Stoffers at defence.gov.au
Tue Apr 11 22:14:36 UTC 2006


> On Tuesday 11 April 2006 16:20, Duncan Lithgow wrote:
> > On Sun, 2006-04-09 at 21:05 -0500, Rocco Stanzione wrote:
> > > those who need the docs.  So your input is very valuable. 
>  The best and
> > > most important thing you could do, if you manage to 
> figure out on your
> > > own what's missing, is to let us know exactly what that 
> is.  Or, if it's
> > > on a wiki page, to add it yourself.
> >
> > This reminds me, has a position been established by the 
> doc-list about
> > the best feedback system for improving docs?
> >
> > I suggest a model based on that used by the online manual 
> at php.net,
> > that a manual with a comments section on each page. Those comments,
> > which are often further explanations and clarification, can then be
> > harvested for useful content for each fixed release of the docs.
> >
> > my $0.02
> >
> > Duncan
> 
> In hte past we have taken suggestion for docs on the mailing 
> list or even 
> direct contact to the maintainer.  An example of the later is today a 
> translator contacted me via IRC and asked about ssome questions on 
> about-kubuntu.
> 
> 

Personally I really dislike the feedback thing on php.net. It looks messy 
and unprofessional, often someone 'clarifies' something which is then
disputed and not resolved. Often the feedback can be over the head of
the typical person trying to learn PHP using the docs, which can just
lead to confusion too.

I've previously mentioned a few ideas regarding the actual editing of the
docs wiki-style, or even a simple PHP/Python based feedback system that
sends the feedback direct to this list. Due to other commitments I haven't
had the time to do up a proper spec and start work yet, it's coming
soon though guys, I promise!

- Robert Stoffers


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20060412/a3720d36/attachment.html>


More information about the ubuntu-doc mailing list