[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[observations] Re: emacspeak manual
A few observations on the gist of this thread.
0) Everyone wants documentation and manuals (or so you'd
1) Everyone wants one manual/documentation set so it is easy
to find stuff
2) Everyone wishes to start a manual project
1 && 2 --
if everyone starts one you wont have one.
0 && 1
No point in asking for docs when what exists isn't being
0 && -1
-1 follows because --the following three sections make it
From the online emacspeak manual's contributing section:
File: emacspeak.info, Node: Contributing, Next: Authoring Guidelines, Up: Announce
How To Contribute To This Manual
This manual is organized as a series of chapters, with each chapter
in a separate file. If you feel capable of contributing to a specific
section, send out a message to the Emacspeak mailing list
`email@example.com'. You can then start adding content to a
local copy of the chapter to which you are contributing. When you feel
you have something to submit, mail out the file to the emacspeak
mailing list- I'll integrate new content as it comes in.
File: emacspeak.info, Node: Authoring Guidelines, Next: Credits, Prev: Contributing, Up: Announce
For this manual to hang together and make sense to the new user at
whom it is targetted, contributors need to stick to a consistent style.
If you plan to contribute content, you should take some time to read the
existing sections -note that many of these are skeletal and the first
contributions will be to flesh these sections out.
If you are familiar with texinfo, go ahead and mark up your content
using texinfo. If you are not, simply author the documentation you
create as plain formatted ASCII. If you do submit files as texinfo
source, make sure to validate them at your end first by running the
files through `makeinfo' -badly created or malformed texinfo source
takes more time to fix than marking up straight text.
File: emacspeak.info, Node: Credits, Prev: Authoring Guidelines, Up: Announce
This initial version draws heavily from the original Emacspeak user
manual, and includes contributions from Jim Van Zandt and Jason White.
Authors who contribute complete sections will be acknowledged here as
well as in the specific section they author.
To unsubscribe from the emacspeak list or change your address on the
emacspeak list send mail to "firstname.lastname@example.org" with a
subject of "unsubscribe" or "help"
Emacspeak Files |
Unsubscribe | Search