An interesting blog by Matt Zimmerman touches on docs

Andrew Kane googoleyes at gmail.com
Mon Jul 12 23:03:58 UTC 2010


Web-based help is a good idea for new-user documentation and for user
docs in general, but it can't effectively be closely coupled to the
user's OS version or package set. Because of this some of the help
will necessarily be inaccurate.
Also, user-based help is not the only help. As a sysadmin I make
constant use of various manpages. (Some may argue that this means I'm
a rather poor sysadmin, but that's neither here nor elsewhere.) It's
very important in my opinion that at minimum, local documentation
should include manpages in *every* package, as part of that package,
and those manpages should be edited so that the information contained
is pertinent to the particular build in the package. I've often run
into manpages that refer to options which are not implemented or to
configuration files which are located elsewhere than the path shown.
Manpages are relatively small chunks of ASCII- I'd be surprised if
there were a manpage extant that runs to more than 50KB- and therefore
shouldn't add excessively to the size of the package. On the other
hand, the ubuntu-docs  package is 270MB, 90% of which I will never
read.
I understand that in many cases manpages need to be bundled together
as in the manpages package which contains man4, 5, and 7. Also, it's
not necessarily reasonable to expect all package maintainers to also
maintain these manpages- but perhaps that is something the docs team
could help with. I would certainly be willing to offer my time to help
with that. Manpages are relatively easy to edit.




More information about the ubuntu-doc mailing list