From: Ciaran Mulloy <crmulloy@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: template for writing Emacs manuals in Org
Date: Thu, 19 May 2016 00:59:26 +0100 [thread overview]
Message-ID: <87zirmc3z5.fsf@gmail.com> (raw)
In-Reply-To: 87d1okbyx5.fsf@russet.org.uk
I'm coming a little late to this thread so apologies!
Most of the previous thread has focused on analysing the various pros
and cons of the various documentation methods, INFOText/html/org, to
produce the final documentation.
I would like to suggest that whatever method is used that
it also supports the development workflow cycle of emacs. Core features
that are documented should also have corresponding testplans.
John Wiegley makes this point in his in his YouTube talk with Sacha Chua
https://www.youtube.com/watch?v=nUjgKoOYxos. He concisely
summed up the workflow issue as 'bugs/tests/documentation'.
It was one of the areas that needed more effort.
The challenge is to elegantly manage the documentation process so that
it caters for the complete workflow development cycle.
I favour the use of org as it has the capability of embedding tests
within the documentation, among other things.
Ciaran
prev parent reply other threads:[~2016-05-18 23:59 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-14 7:21 template for writing Emacs manuals in Org Eric Abrahamsen
2016-05-16 17:37 ` Kaushal Modi
2016-05-16 17:55 ` John Hendy
2016-05-16 18:08 ` Rasmus
2016-05-16 18:40 ` Thomas S. Dye
2016-05-16 20:02 ` Nicolas Goaziou
2016-05-16 21:33 ` Thomas S. Dye
2016-05-17 5:52 ` Nicolas Goaziou
2016-05-17 14:44 ` Thomas S. Dye
2016-05-17 15:37 ` Nicolas Goaziou
2016-05-17 18:36 ` Thomas S. Dye
2016-05-17 18:56 ` Charles C. Berry
2016-05-17 18:56 ` Nick Dokos
2016-05-18 9:21 ` Rasmus
2016-05-18 14:56 ` Jonathan Leech-Pepin
2016-05-18 16:20 ` Nicolas Goaziou
2016-05-18 16:43 ` Rasmus
2016-05-17 0:23 ` Eric Abrahamsen
2016-05-17 3:32 ` Thomas S. Dye
2016-05-17 4:16 ` Eric Abrahamsen
2016-05-17 7:35 ` Rasmus
2016-05-17 8:34 ` Eric Abrahamsen
2016-05-17 13:24 ` Phillip Lord
2016-05-18 23:59 ` Ciaran Mulloy [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
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zirmc3z5.fsf@gmail.com \
--to=crmulloy@gmail.com \
--cc=emacs-orgmode@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 public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).