[kde-doc-english] Outdated man page policy?

[Anne Wilson]

On Saturday 12 September 2009 03:37:23 Raphael Kubo da Costa wrote:
> 2009/9/6 Burkhard Lück <lueck at hube-lueck.de>:
> > Am Sonntag 06 September 2009 20:13:48 schrieb Raphael Kubo da Costa:
> >> 2009/9/6 Allen Winter <winter at kde.org>:
> >> > On Saturday 05 September 2009 5:56:30 pm Raphael Kubo da Costa 
wrote:
> >> >> Hi there,
> >> >>
> >> >> I'm one of the Ark maintainers, and while looking at bug 206284, it
> >> >> came to my attention that there is a man page for ark which was
> >> >> written in 2005 and has never been updated. I was thinking of
> >> >> removing it altogether, as it is likely not to be kept up-to-date.
> >> >>
> >> >> I tried to look for some kind of policy for this over Techbase, but
> >> >> didn't find anything. So my question is whether I can freely remove
> >> >> that man page from kdeutils/doc/ark or if it should remain there,
> >> >> even if not up-to-date and likely to confuse some users (besides, not
> >> >> many KDE applications seem to have man pages).
> >> >
> >> > Raphael,
> >> >
> >> > I think we have general policy that "no documentation is better than
> >> > wrong documentation".
> >> >
> >> > Personally, I like man pages and wish we had at least basic man pages
> >> > for all the apps. But if don't want to support a man page for Ark,
> >> > then certainly you should remove the old, outdated file(s).
> >>
> >> Hi, Allen,
> >>
> >> Is it up to the application's maintainer to keep the man page and
> >> other pieces of documentation updated, or is there any way the doc
> >> team can help me? I could try to update the man page, but I've never
> >> done anything related to DocBook, nor do I think I'll remember to do
> >> that very often.
> >
> > Raphael,
> > just send some plain text with an updated man page, I can markup it
> > quickly to docbook and move it into svn documentation and into the i18n
> > tool chain.
> >
> > You don't need to deal with docbook.
>
> Hi there,
>
> Sorry for taking so long to answer. I'm finally attaching an updated man
> page.
>
> I'm not sure if the language is as friendly as possible, so feel free
> to edit it (or add/remove sections if necessary). I also merged the
> Authors and Author section. Also feel free to add yourself to the
> Authors list.
>
> When you're done, please let me know to close the bug report.
>
> Thanks!

From a user point of view, this man page  is a diamond of unusual clarity. :-)

Anne
--
New to KDE4? - get help from http://userbase.kde.org
Just found a cool new feature?  Add it to UserBase
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
Url : http://mail.kde.org/pipermail/kde-doc-english/attachments/20090912/6d0a18d4/attachment.sig