Acronyms believed harmful

Ceri Davies ceri at FreeBSD.org
Fri Jul 9 17:11:33 UTC 2004


On Fri, Jul 09, 2004 at 12:37:04PM -0400, Leonard Zettel wrote:
> On Friday 09 July 2004 12:06 pm, Ceri Davies wrote:
> > On Fri, Jul 09, 2004 at 10:38:52AM -0400, Leonard Zettel wrote:
> > > Things like DTD are not English, they
> > > are jargon! They place an unnecessary
> > > burden on the reader. This burden
> > > falls most heavily on newbies and
> > > (I would imagine) people to whom
> > > English is a second (or third or fourth)
> > > language - exactly the people who
> > > most need the help of clear documentation.
> > >
> > > At a minimum I plead for the following rule:
> > > all uses of acronyms in any document
> > > should include the term fully spelled out
> > > at the first appearance of said acronym.
> >
> > Well, there's a work in progress(ish) to have the first use of an
> > acronym expand to a link to it's entry in the glossary.  This can't
> > happen until the glossary is full.  Help to fill it.
> >
> Love to! How?

You'll need to check out a copy of the doc tree and add entries to the
glossary file
doc/en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml.  See also
my mail to Bill Moran for areas to focus on.

Thanks for the help!

Ceri
-- 
It is not tinfoil, it is my new skin.  I am a robot.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20040709/94120ef6/attachment.sig>


More information about the freebsd-doc mailing list