Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 14 Jun 2001 13:24:23 -0700
From:      "Bruce A. Mah" <bmah@FreeBSD.ORG>
To:        Valentino Vaschetto <logo@osd.bsdi.com>
Cc:        John Baldwin <jhb@FreeBSD.ORG>, Nik Clayton <nik@FreeBSD.ORG>, freebsd-doc@FreeBSD.ORG, Chern Lee <chern@meow.osd.bsdi.com>
Subject:   Re: Style/Grammar/Writing Guidelines 
Message-ID:  <200106142024.f5EKOOd75796@bmah-freebsd-0.cisco.com>
In-Reply-To: <Pine.BSF.4.31.0106141255010.67118-100000@meow.osd.bsdi.com> 
References:  <Pine.BSF.4.31.0106141255010.67118-100000@meow.osd.bsdi.com>

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

[-- Attachment #1 --]
If memory serves me right, Valentino Vaschetto wrote:

> As do I. Murray, Chern and I are working to get the handbook ready for a
> second printed version. We have the time and the ability to make the
> handbook v2.0 really good, and it will :).

I think that's great.  Regardless of any differences of opinion we may 
have about writing style, I know you'll be fixing lots of technical 
errors, correcting misspellings, and making organizational 
improvements.  This is a Good Thing (TM).

> What would be nice is if people sent me (or -doc) things that SUCK in the
> handbook, then I could make a list so Chern and I have some goals to
> complete. Indexing is being taken care of.. loosly written chapters are
> being rewritten/updated.. what else do you guys suggest?

The installation chapter needs some work, in two ways.  First, it 
includes a not-very-well-synched version of the hardware compatability 
list.  I'd like to see this refer instead to the hardware lists that 
come with each release, rather than to try to duplicate the contents.  
The hardware list is release- and architecture-dependent, which makes 
keeping the version in the handbook synchronized to the version in the 
release documentation pretty much impossible.  (Even if we were to try 
to keep it synched to, say, 4-STABLE, it's still a pain to keep it up 
to date.)

Somewhat paradoxically, we could have some better synchronization
between the rest of the installation chapter and the corresponding parts
of the release documentation (I'm not sure in which direction the
synchronization should go).  The installation instructions don't change
anywhere near as quickly, and it makes sense to have them in both paces.

Just a thought.....

Bruce.




[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (FreeBSD)
Comment: Exmh version 2.3.1+ 05/14/2001

iD8DBQE7KR132MoxcVugUsMRApteAKD+PnrRpwWwOWQrm86MuYtbAvyDmwCgkngM
eU9ZPsLPoCHClj2XfvYhYzY=
=g2Az
-----END PGP SIGNATURE-----
home | help

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