all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Frank Schmitt <ich@Frank-Schmitt.net>
Subject: Re: Procedure for changing the FAQ
Date: Wed, 23 Apr 2003 16:08:25 +0200	[thread overview]
Message-ID: <uof2xs3vq.fsf@hschmi22.userfqdn.rz-online.de> (raw)
In-Reply-To: 200304231311.h3NDBAs4012370@rum.cs.yale.edu

"Stefan Monnier" <monnier+gnu/emacs@rum.cs.yale.edu> writes:

> I think the FAQ has generally not been maintained very well for the simple
> reason that such FAQs should be addressed by the manual rather than
> by a FAQ.  Admittedly, the way it's presented is different, so there's
> some sense to having a FAQ additionally to the manual, but please think
> of it as another kind of index to the manual: most answers should @xref
> to the relevant part of the manual.  If there's no such thing in the
> manual, then the manual needs to be updated.

I partly disagree, partly agree. First of all, the main documentation
is huge and the answers to the questions especially newbies have are
often in sections where they wouldn't expect them.

Therefor a FAQ should explain all major concepts, but concentrate on
the most important parts (e.g. only mention the most often used command
switches) while referring to the manual for more details. However, the
informations contained should be sufficient to get you running with a
basic setup.

It's hard to explain, perhaps you throw an eye at
http://my.gnus/org/FAQ where I tried to make a FAQ that meets my idea
of a good one to see what I'm talking about. 

(BTW: This shows that it isn't this much work, the FAQ contains at the
moment 68 question - answer pairs and the text version has about 1,600
lines and it took me all together only about 2-3 weeks to write it from
scratch)

MFG Frank

-- 
WANTED: A nice signature
REWARD: none

  reply	other threads:[~2003-04-23 14:08 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2003-04-22 15:45 Procedure for changing the FAQ Glenn Morris
2003-04-23 10:15 ` Eli Zaretskii
2003-04-23 13:11   ` Stefan Monnier
2003-04-23 14:08     ` Frank Schmitt [this message]
2003-04-23 20:02       ` Eli Zaretskii
2003-04-23 22:31         ` Alex Schroeder
2003-04-24  6:03           ` Eli Zaretskii
2003-04-24  7:46             ` Kai Großjohann
2003-04-26  2:32               ` Richard Stallman
2003-04-26 21:24                 ` Kai Großjohann
2003-04-28  4:38                   ` Richard Stallman
2003-04-24 23:14       ` Richard Stallman
2003-04-23 18:48     ` Glenn Morris
2003-04-23 19:50     ` Eli Zaretskii
2003-04-23 18:37   ` Glenn Morris
2003-04-23 20:06     ` Eli Zaretskii
2003-04-24 12:44       ` Simon Josefsson
2003-04-23 20:40     ` Robert J. Chassell
2003-04-26 13:46     ` Richard Stallman

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=uof2xs3vq.fsf@hschmi22.userfqdn.rz-online.de \
    --to=ich@frank-schmitt.net \
    /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.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.