Date: Fri, 9 Jul 2004 18:11:32 +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: <20040709171132.GD29928@submonkey.net> In-Reply-To: <200407091237.04562.zettel@acm.org> References: <200407091038.52304.zettel@acm.org> <20040709160642.GB29928@submonkey.net> <200407091237.04562.zettel@acm.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--mmR5Tf+WJGm+vTLg Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable 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 --=20 It is not tinfoil, it is my new skin. I am a robot. --mmR5Tf+WJGm+vTLg Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (FreeBSD) iD8DBQFA7tHDocfcwTS3JF8RAueQAJ9v4yBN1eQ0HnyXH8p2YQ52Kw8pPgCeIM07 bsEeQ1xuUkOuNmH1W5Q1cOc= =japq -----END PGP SIGNATURE----- --mmR5Tf+WJGm+vTLg--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040709171132.GD29928>