Gnus development mailing list
 help / color / mirror / Atom feed
From: "Adam Sjøgren" <asjo@koldfront.dk>
To: ding@gnus.org
Subject: Re: Proposed new introductory section to the Gnus manual
Date: Mon, 19 Aug 2019 19:55:51 +0200	[thread overview]
Message-ID: <87zhk5ox94.fsf@tullinup.koldfront.dk> (raw)
In-Reply-To: <87o90mm4x2.fsf@ericabrahamsen.net>

Eric writes:

> Let me know if you have any comments/questions/suggestions!

Nitpicks and comments follow.

> 			     ━━━━━━━━━━━━━
> 			      DON’T PANIC
> 			     ━━━━━━━━━━━━━

It's cute with a Douglas Adams reference, but I think a headline that is
more descriptive of the contents is warranted.

> Welcome, gentle user, to the Gnus newsreader and email client! Gnus is
> unlike most clients, in part because of its gross configurability, and

I agree with (the other) Eric that "gross" sounds a little too.. icky?

> While Gnus is now a fully-featured email client, it began life as a
> newsreader, and its DNA is still newsreader DNA.

I think I understand where you are going with this, but Gnus is still a
newsreader, right? This sentence sounds like it isn't anymore.

> 3. Gnus will only show you groups with unread or ticked articles;

Is "ticked" articles a Gnusism? Maybe "marked" or "flagged" would be
more accessible to a newcomer?

Come to think of it, will the average email user who hasn't heard of
usenet know that "article" for mail is synonymous with "email"? A little
later you use the term "message", which might be less confusing up here
as well?

> If this seems draconian, think of it as Enforced Inbox Zero.

"Enforced" sounds so negative. Automatic Inbox Zero? "Now, with more AIZ!"

> This is the way Gnus works by default. It is possible to make it work
> more like an email client (always showing read groups and read
> messages), but that will take some effort on the part of the user, and
> Gnus won’t ever really like it.

Does Gnus have an opinion? It's more like it is unnatural or counter to
the design, right?

(I said I would nitpick...)

>   When sending messages, too, Gnus makes a distinction between news-like
>   and mail-like behavior. News servers handle mail delivery themselves,

Perhaps "message delivery"?

>   Mail message composition starts with “m” in the *Group* buffer, or “r”
>   if you’re replying to an existing message.

Won't most users expect to use R or F, rather than r?

                                 o o o

I'm not really sure where you're aiming with this. It's too vague to be
a tutorial, it's too limited to be a manual. An email-biased
introduction? Perhaps use a headline to set the tone/ambition.

It is hard to write a tutorial without getting bogged down in details
that won't fit every reader, I know - even from experience.

Maybe it's been too long since I've read the manual. (And no, I won't go
read any of the vim-tutorials you referred to ;-))

I think I sound more negative than I wanted to, here. It makes sense to
me, to have a more gentle introduction/overview in the beginning of the
manual and I think you've got a good start.

Documentation is hard, let's go code.


  Best regards,

    Adam

-- 
 "Lanois can get passionate about what he feels to be         Adam Sjøgren
  true," Dylan said. "He's not above smashing guitars.   asjo@koldfront.dk
  I never cared about that unless it was one of mine."




      parent reply	other threads:[~2019-08-19 17:55 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-18 23:26 Eric Abrahamsen
2019-08-19  0:34 ` dick.r.chiang
2019-08-19  1:06   ` Eric Abrahamsen
2019-08-19  2:46     ` Bob Newell
2019-08-19  7:01       ` Eric S Fraga
2019-08-20  4:26         ` Eric Abrahamsen
2019-08-20 11:37           ` dick
2019-09-09  8:13             ` Eric Abrahamsen
2019-09-09 11:52               ` dick
2019-09-09 18:39                 ` Bob Newell
2019-09-09 19:48                   ` dick
2019-09-10  2:36                     ` Eric Abrahamsen
2019-09-10 20:21                       ` dick
2019-09-10 23:50                         ` Eric Abrahamsen
2019-09-12 19:19                           ` Michael
2019-09-13  9:19                             ` Eric Abrahamsen
2019-09-13 15:08                               ` Eric S Fraga
2019-09-13 16:54                               ` Michael
2019-09-16  2:51                                 ` Eric Abrahamsen
2019-09-13 18:24                               ` Bob Newell
2019-09-13 18:39                                 ` Change input method or smtp server depending on addressee (was: Proposed new introductory section to the Gnus manual) Jorge A. Alfaro-Murillo
2019-09-14 17:38                                   ` Change input method or smtp server depending on addressee Štěpán Němec
2019-09-16 18:26                                     ` Bob Newell
2019-09-16  8:52                                   ` Robert Pluim
2019-12-20 12:54                                   ` 황병희
2019-09-16  2:55                                 ` Proposed new introductory section to the Gnus manual Eric Abrahamsen
2019-09-16 18:34                                   ` Bob Newell
2019-09-10 20:39                     ` Adam Sjøgren
2019-09-10 20:54                       ` dick
2019-09-12  5:31                       ` Steinar Bang
2019-09-07 19:50           ` Adam Sjøgren
2019-09-08 17:00             ` Bob Newell
2019-08-19 16:01       ` Adam Sjøgren
2019-08-19 18:04         ` Bob Newell
2019-08-19 18:09           ` Adam Sjøgren
2019-08-20  4:29         ` Eric Abrahamsen
2019-09-07 19:44           ` Adam Sjøgren
2019-08-19 16:16       ` Eric S Fraga
2019-08-20  7:08       ` Bjørn Mork
2019-08-20  9:51         ` Eric S Fraga
2019-08-20 10:32           ` Bjørn Mork
2019-08-20 10:55             ` Eric S Fraga
2019-08-19 17:55 ` Adam Sjøgren [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87zhk5ox94.fsf@tullinup.koldfront.dk \
    --to=asjo@koldfront.dk \
    --cc=ding@gnus.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).