all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Per Abrahamsen <abraham@dina.kvl.dk>
Cc: emacs-devel@gnu.org
Subject: Re: Emacs setup assistants
Date: Sun, 30 May 2004 10:15:01 +0200	[thread overview]
Message-ID: <rju0xywcu2.fsf@sheridan.dina.kvl.dk> (raw)
In-Reply-To: 40B7E6CB.30602@cox.net

"David A. Cobb" <Superbiskit@cox.net> writes:

> I would really hate to see the information separated physically from
> the code!  That's a guarantee one of them will be wrong.

There are two levels of documentation.  One is tool-centric, and the
other is user centric.  Both are needed.  Tool-centric documentation
says "I'm a tool, here is what I can do".  User-centric documentation
says "I'm a user.  I have this problem.  Here is how I solved it".

The tool-centric documentation should be as close to the code as
possible, in order to stay complete and up to date.  Doc-strings and
Customize are great for providing tool-centric documentation.

But user-centric documentation needs another viewpoint.  Assistants
are supposed to be user-centric, otherwise they would just be another
interface to Customize.  I don't care whether they are written in a
markup language with embedded Lisp, or on Lisp with an embedded markup
language.  But if they are written in Lisp, they will (logically) be
separate from the main code body, unlike doc strings and defcustoms.  




  reply	other threads:[~2004-05-30  8:15 UTC|newest]

Thread overview: 60+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-05-18 20:55 Emacs setup assistants Lars Magne Ingebrigtsen
2004-05-19  6:34 ` David Kastrup
2004-05-19  7:32   ` Lars Magne Ingebrigtsen
2004-05-19 10:31     ` David Kastrup
2004-05-19 15:29       ` Ted Zlatanov
2004-05-19 20:49         ` Thien-Thi Nguyen
2004-05-19 21:35           ` Lars Magne Ingebrigtsen
2004-05-20 13:17       ` Richard Stallman
2004-05-20 17:31         ` Ted Zlatanov
2004-05-21 14:12           ` Richard Stallman
2004-05-21 17:42             ` Ted Zlatanov
2004-05-21 19:09               ` Lars Magne Ingebrigtsen
2004-05-21 18:32             ` Eli Zaretskii
2004-05-22 21:44               ` Richard Stallman
2004-05-19  8:18   ` Per Abrahamsen
2004-05-19  9:59     ` Juri Linkov
2004-05-20  7:25       ` David Kastrup
2004-05-20  9:43         ` Eli Zaretskii
2004-05-20 10:57           ` David Kastrup
2004-05-20 13:44             ` Eli Zaretskii
2004-05-20 17:00               ` David Kastrup
2004-05-20 18:31                 ` Eli Zaretskii
2004-05-20 19:05                   ` Jon Ericson
2004-05-20 19:07                   ` Ted Zlatanov
2004-05-21 18:12                     ` Eli Zaretskii
2004-05-21 18:04                       ` Ted Zlatanov
2004-05-22 11:09                         ` Per Abrahamsen
2004-05-24 14:10                           ` Ted Zlatanov
2004-05-24 19:46                             ` David Kastrup
2004-05-25 18:16                               ` Ted Zlatanov
2004-05-25 20:59                                 ` Juri Linkov
2004-05-25 22:57                                   ` A.J. Rossini
2004-05-25 23:19                                     ` Miles Bader
2004-05-26  7:11                                       ` David Kastrup
2004-05-26 14:04                                         ` Ted Zlatanov
2004-05-27  8:50                                           ` David Kastrup
2004-05-26 14:06                                     ` Ted Zlatanov
2004-05-26 22:14                                     ` Juri Linkov
2004-05-26 18:57                                   ` Per Abrahamsen
2004-05-26 10:42                                 ` Eli Zaretskii
2004-05-26 13:59                                   ` Ted Zlatanov
2004-05-27 23:54                                   ` Richard Stallman
2004-05-26 15:26                             ` Stefan Monnier
2004-05-27 15:07                               ` Ted Zlatanov
2004-05-27 16:59                                 ` René Kyllingstad
2004-05-27 16:59                                 ` René Kyllingstad
2004-05-22 13:28                         ` Eli Zaretskii
2004-05-20 20:57                   ` David Kastrup
2004-05-21 17:57                     ` Eli Zaretskii
2004-05-22 11:01                       ` Per Abrahamsen
2004-05-21 14:11                   ` Richard Stallman
2004-05-29  1:26               ` David A. Cobb
2004-05-30  8:15                 ` Per Abrahamsen [this message]
2004-05-20 10:00       ` Per Abrahamsen
2004-05-19  6:43 ` David Kastrup
2004-05-19 13:45 ` Richard Stallman
2004-05-19 15:04   ` David Kastrup
2004-05-19 20:07     ` Eli Zaretskii
2004-05-19 16:41   ` Ted Zlatanov
  -- strict thread matches above, loose matches on Subject: below --
2004-05-26 11:48 Berndl, Klaus

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=rju0xywcu2.fsf@sheridan.dina.kvl.dk \
    --to=abraham@dina.kvl.dk \
    --cc=emacs-devel@gnu.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.
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.