At 18:13 2000-06-18 -0500, Uncle Meat wrote:
>Not a syllable of disagreement on this. I still start new things that I
>never needed before and spend days/weeks/months trying to get it right
>because the information readily available in howtos is version 1.0 and
>we're using version 10.7 or something similar.
The best thing to do when you've figured this out is to write up the
necessary changes to the FAQ/HOWTO and send it to the maintainer of that
document. Most likely they're doing this in their spare time and could use
a hand keeping the document up to date. If your contribution is
significant, you'll likely be added to the Credits or Revisions section for
that document.
>It can also be made a bit more understandble by either using different
>wording (jargon) or describe concepts that explain what it is you're about
>to be confused with (glossary or something similar).
Many authors are guru types and could use some help translating things for
regular users. If you run into a HOWTO that uses a lot of jargon, go ahead
and create a glossary. Attached is an example of what a glossary looks like
using DocBook, which is the current Linux Documentation Project (LDP)
document format.
DocBook is a SGML language that looks somewhat like HTML (which is itself
an SGML language). So if you've written any HTML, it won't be hard at all.
Even if you haven't written any HTML, it isn't hard to figure out. Just
write up your glossary and send it to the maintainer of the document. If
you can't contact the maintainer, send your changes to
[EMAIL PROTECTED] and explain that you couldn't contact the maintainer.
Tony
--
Anthony E. Greene <[EMAIL PROTECTED]>
PGP Key: 0x6C94239D/7B3D BD7D 7D91 1B44 BA26 C484 A42A 60DD 6C94 239D
Linux: The choice of a GNU Generation.
--
To unsubscribe: mail [EMAIL PROTECTED] with "unsubscribe"
as the Subject.
