Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 9 Jul 2004 17:06:42 +0100
From:      Ceri Davies <ceri@FreeBSD.org>
To:        Leonard Zettel <zettel@acm.org>
Cc:        freebsd-doc@freebsd.org
Subject:   Re: Acronyms believed harmful
Message-ID:  <20040709160642.GB29928@submonkey.net>
In-Reply-To: <200407091038.52304.zettel@acm.org>
References:  <200407091038.52304.zettel@acm.org>

index | next in thread | previous in thread | raw e-mail

[-- Attachment #1 --]
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.

Ceri
-- 
It is not tinfoil, it is my new skin.  I am a robot.

[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (FreeBSD)

iD8DBQFA7sKRocfcwTS3JF8RAndZAJ93hOzoY2Tl0J21llL2WwiVg17dKgCfQGXL
VhQgq69dKDzHvIdcNa9ylw0=
=n6mk
-----END PGP SIGNATURE-----
help

Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040709160642.GB29928>