Date: Fri, 9 Jul 2004 18:09:56 +0100 From: Ceri Davies <ceri@FreeBSD.org> To: Bill Moran <wmoran@potentialtech.com> Cc: freebsd-doc@freebsd.org Subject: Re: Acronyms believed harmful Message-ID: <20040709170956.GC29928@submonkey.net> In-Reply-To: <20040709125207.66591fc2.wmoran@potentialtech.com> References: <200407091038.52304.zettel@acm.org> <20040709160642.GB29928@submonkey.net> <20040709125207.66591fc2.wmoran@potentialtech.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--ZjLa2K+dB9SFbrgo Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Jul 09, 2004 at 12:52:07PM -0400, Bill Moran wrote: > Ceri Davies <ceri@FreeBSD.org> wrote: > > On Fri, Jul 09, 2004 at 10:38:52AM -0400, Leonard Zettel wrote: > >=20 > > > 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. > >=20 > > 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. >=20 > I was going to _try_ to spend some time contributing to this over > the weekend. >=20 > Before I start, I have a policy question: If we look at tech terms > that are NOT FreeBSD-specific (such as DTD) should the FreeBSD > glossary contain a full definition, or possibly a link to another > source? Originally I had intended for this to be FreeBSD specific - I'm now of the opinion that this is kind of unworkable and a bit pointless to boot. The main things to focus on would be things that crop up a lot, and stuff marked up in firstterm or acronym elements. Ceri --=20 It is not tinfoil, it is my new skin. I am a robot. --ZjLa2K+dB9SFbrgo Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (FreeBSD) iD8DBQFA7tFkocfcwTS3JF8RAiXVAJ4sP0gLuaRTtOBlSTfNcC5mg9gx1ACcDwXi Voch5kmsf9hQ9D5EgF6iRJA= =4893 -----END PGP SIGNATURE----- --ZjLa2K+dB9SFbrgo--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040709170956.GC29928>