Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 18 Feb 2002 18:56:24 -0500
From:      Michael Lucas <mwlucas@blackhelicopters.org>
To:        Tom Rhodes <darklogik@pittgoth.com>
Cc:        bmah@FreeBSD.ORG, freebsd-doc@FreeBSD.ORG
Subject:   Re: BSDCon Doc BoF Notes
Message-ID:  <20020218185624.A11805@blackhelicopters.org>
In-Reply-To: <3C719161.5090803@pittgoth.com>; from darklogik@pittgoth.com on Mon, Feb 18, 2002 at 06:42:25PM -0500
References:  <200202182315.g1INFpc93221@bmah.dyndns.org> <3C719161.5090803@pittgoth.com>

next in thread | previous in thread | raw e-mail | index | archive | help
Excellent summary, Bruce.

If anyone out there feels like mucking with toolchains, a toolchain to
convert mdoc to xml, and vica versa, would be an excellent target.

On Mon, Feb 18, 2002 at 06:42:25PM -0500, Tom Rhodes wrote:
> > Michael Lucas: Many of the
> > problems can be summed up as, "It's not enough to write to be
> > understood; you have to write so that you cannot be misunderstood".
>
> Hasn't Michael stated this many times over in the past ;)  Should we add 
> it to the FDP primer?

And I will continue to say it until a) people DO IT, b) I am hit over
the head with a double-bladed axe by outraged -doc committers who are
utterly sick of me.  This is endemic in our docs, as well as in most
technical writings these days.

> > Generally accepted that many contributors to the Handbook (many of
> > whom are not professional writers) will cause this problem.  Maybe
> > needs a copy editor?  Murray: PRs pointing out specific problems are
> > welcomed, even if there's no patch.

I'm working on some PRs to point out the most egregious examples of
this stuff, but it's a pain.  The next edition of the Handbook needs a
copy editor, period end.  Copy editors expect to be paid, though...

> > About this time, kicked out of the room by the next BOF.
> > 
> You were kicked out of the room?  Pretty...

Well, they were scheduled to run from 9-10PM, and it was 9:15 already,
so I can't blame them.  :)

All in all, a good BoF.  Nik also suggested, after the Bof, having a
"FreeBSD DocProj Summit" around USENIX.  We could take all the docs,
print them out, nail them to the wall, break out our red pens, and say
"Okay, what the fsck are we going to *do* with this mess?"  I think
it's an excellent idea.  Now if I can just get to USENIX...

==ml

-- 
Michael Lucas		mwlucas@FreeBSD.org, mwlucas@BlackHelicopters.org
my FreeBSD column: http://www.oreillynet.com/pub/q/Big_Scary_Daemons

http://www.blackhelicopters.org/~mwlucas/

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




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