discuss: [jfleck@inkstain.net: GNOME Documentation Style Guide]
Subject:
Re: [jfleck@inkstain.net: GNOME Documentation Style Guide]
From:
David Merrill ####@####.####
Date:
7 Jul 2001 15:57:05 -0000
Message-Id: <20010707115635.E9863@lupercalia.net>
On Sat, Jul 07, 2001 at 10:08:30AM +0200, Mariusz Pekala wrote:
> From: "David Merrill" ####@####.####
>
> > > >> Avoid talking down to your reader
> > > > There are few experiences more irritating for a user than
> > > > documentation that says an action is easy or quick, when in
> > > > fact the user can not complete the action. Do not qualify or
> > > > prejudge actions. Stay factual.
> > > >
> > > >It's important to give the reader some idea of the difficulty of
> > > >a task. It's not only so that the reader will know about how much
> > > >time to allocate to it, but also so that the reader can decide is s/he
> > > >wants to undertake it at all.
> > >
> > > This is the absolute most important. This linux shit is hard for most
> > > people. Don't make them feel stupid.
> >
> > Absolutely!
>
> Oh, no! Sometimes you should make me feel stupid.
Okay, you're stupid. Happy?
;-)
--
Dr. David C. Merrill http://www.lupercalia.net
Linux Documentation Project ####@####.####
Collection Editor & Coordinator http://www.linuxdoc.org
Kiss your keyboard goodbye!
