Re: Proof-reading manuals (was Re: Rmail mbox-format branch)

From:

Luc Teirlinck

Subject:

Re: Proof-reading manuals (was Re: Rmail mbox-format branch)

Date:

Tue, 14 Sep 2004 20:12:49 -0500 (CDT)

Kim Storm wrote:
To help organize the process, I have added a list of all the
relevant texi files in admin/FOR-RELEASE like this:
DONE SECTION
---------------------------------------------
man/abbrevs.texi
For lispref this way of organizing things may be reasonable, but for
man it makes no sense. It might be nice to have things like
man/cl.texi updated, but such things are a luxury right now. What we
worry about now is the Emacs and Elisp manual and info.texi.
I proofread all of the Elisp manual except the chapters (if you do
`C-h i elisp'):
Advising Functions
Debugging
Customization
Modes
Text
Processes
Display
Calendar
I did also not check or update:
Antinews
GNU Free Documentation License
GPL
Standard Buffer-Local Variables
Standard Keymaps
Standard Hooks
New Symbols
However, I have read Text up to and including `(elisp)Maintaining Undo'.
I _will_ read Customization because there still is some unfinished
business there.
I still need to go over some details in some of the sections I read,
due to developments after I read them.
For the Emacs manual, I read everything up to and including (in Info
order), Info Chapter 29, Commands for Human Languages. (The "29" only
makes sense if you are using texinfo 4.7.)
However, I skipped `(emacs)HTML Mode' and `(emacs)Nroff Mode', because
I never use the material in those sections (I do not know HTML, SGML,
XML nor NROFF).
I will still have to take a closer look at some sections I already
read.
Of course, the original aim was to have everything proofread by at
least two persons, but that seems unrealistic now.
Note that the reason why all of this takes time is not just the
proofreading and correcting of the documentation. All kinds of bugs
come to light during proofreading and they have to be corrected.
Sincerely,
Luc.