Re: Why newbies don't RTFM...

From: Netocrat (netocrat_at_dodo.com.au)
Date: 09/26/05


Date: Tue, 27 Sep 2005 01:13:27 +1000

On Mon, 26 Sep 2005 01:09:11 -0400, Rick Moen wrote:

> Some of us involved in Linux documentation have tended to get a little
> cynical over requests for documentation "tweaks".

It seems similar to trying to fix an intricate bug - easy for someone to
suggest a fix that breaks something else.

[...]
> Moen's Law of Documentation: "The more you write, the less they
> read."
[...]
> Thus, greater conciseness often does much more good than do longer &
> more detailed explanations. Or, what might be needed is better
> indexing, or following the classic journalist's inverted pyramid
> format (http://mtsu32.mtsu.edu:11178/171/pyramid.htm), or the short
> answer / long answer format I often use -- or just a polite suggestion
> to Read The Friendly Manual.

All good suggestions.

> Naturally, there is a place for more-accessible documentation -- but
> there might just be a need for people to have better access to what
> already exists.

Yes, it's a good idea not to duplicate resources - except for development
that relies on it for testing alternatives.

> There are entire projects devoted to that already, e.g., the "Newbieized
> Help Files" at http://www.justlinux.com/nhf/ . I personally don't care
> for those (to digress slightly, for a moment), for several reasons:
[all sensible].
> But there are other projects.

The current projects that inspire me most are those that do what Linux/OSS
is strong at - interoperating and converting between formats. That's why
I mentioned KDE's help browser as doing a great job of integrating man,
info and KDE help pages. ESR's tool to convert manpages into DocBook
format also seems like a good idea. I read that many of the LDP HowTo's
are stored in this format too. It seems ideal for help documentation
because it is renderable in many different forms - PS, PDF, HTML, etc - as
well as being semantically tagged - understood by programs as well as
human readers - which makes it possible to tweak the documentation display
based on the user's skill level/requirements without the need for a
separate set of "newbie-centred" documentation.

[...]
> If someone says to me "I don't _want to understand_ what I'm doing; I
> only want to know [foo]", then I can sympathise with that, but there are
> other people I'd rather assist in the limited amount of time I have for
> entirely volunteer activity. (I'd rather help people who I expect will
> make meaningful contributions to the technical community in the future.)

That's practical as well as altruistic and probably explains a lot of the
attitude that leads to some c.o.l.m posters' disinterest (to put it
mildly) in any focus on unskilled users who don't intend on skilling up.

[...]

-- 
http://members.dodo.com.au/~netocrat


Relevant Pages

  • Replacing RDoc: what do you want to see?
    ... replace (not fix) RDoc, ... The main task would probably be to revise the format ... more meaningful and consistent documentation while ...
    (comp.lang.ruby)
  • [ANNOUNCE] GIT 1.5.0-rc3
    ... This contains the "git user's manual" by J. Bruce Fields. ... Fix git-update-index to work with relative pathnames. ... Documentation: add git user's manual ... reflog gc: a tag that does not point at a commit is not a crime. ...
    (Linux-Kernel)
  • Whats in git.git (stable)
    ... Updates to gitk from Paul Mackerras to fix longstanding menu ... Eric also has quite a few fixes to git-svn. ... documentation for 'git commit' to make it easier to teach new ... Hide plumbing/transport commands from bash completion. ...
    (Linux-Kernel)
  • 2.6.9-rc2-mm2
    ... It has a number of tunables and lots of documentation - see the changelog ... This is the code which uses kexec ... Fix fsync() with ext3's data=journal mode ... Hack around ia64 non-compile problem. ...
    (Linux-Kernel)
  • [ANNOUNCE] GIT 1.4.0
    ... You can "alias" git commands with leading arguments in your ... Documentation set, especially the tutorial, has been reworked. ... Builtin git-rev-parse. ... Fix git-pack-objects for 64-bit platforms ...
    (Linux-Kernel)