From owner-freebsd-doc@FreeBSD.ORG  Fri Jul  9 16:06:43 2004
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id C2D2E16A4CF
	for <freebsd-doc@freebsd.org>; Fri,  9 Jul 2004 16:06:43 +0000 (GMT)
Received: from shrike.submonkey.net (cpc2-cdif3-6-0-cust204.cdif.cable.ntl.com
	[81.103.67.204])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 820BD43D1F
	for <freebsd-doc@freebsd.org>; Fri,  9 Jul 2004 16:06:43 +0000 (GMT)
	(envelope-from setantae@submonkey.net)
Received: from setantae by shrike.submonkey.net with local (Exim 4.34;
	FreeBSD)	id 1Bixta-000M8Q-4G; Fri, 09 Jul 2004 17:06:42 +0100
Date: Fri, 9 Jul 2004 17:06:42 +0100
From: Ceri Davies <ceri@FreeBSD.org>
To: Leonard Zettel <zettel@acm.org>
Message-ID: <20040709160642.GB29928@submonkey.net>
Mail-Followup-To: Ceri Davies <ceri@FreeBSD.org>,
	Leonard Zettel <zettel@acm.org>, freebsd-doc@freebsd.org
References: <200407091038.52304.zettel@acm.org>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="K0M4iRgkWWXhiQ9N"
Content-Disposition: inline
In-Reply-To: <200407091038.52304.zettel@acm.org>
X-PGP: finger ceri@FreeBSD.org
User-Agent: Mutt/1.5.6i
Sender: Ceri Davies <setantae@submonkey.net>
cc: freebsd-doc@freebsd.org
Subject: Re: Acronyms believed harmful
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Fri, 09 Jul 2004 16:06:44 -0000


--K0M4iRgkWWXhiQ9N
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

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.
>=20
> 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
--=20
It is not tinfoil, it is my new skin.  I am a robot.

--K0M4iRgkWWXhiQ9N
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (FreeBSD)

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

--K0M4iRgkWWXhiQ9N--