[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [O] template for writing Emacs manuals in Org

From: Ciaran Mulloy
Subject: Re: [O] template for writing Emacs manuals in Org
Date: Thu, 19 May 2016 00:59:26 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux)

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.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]