Date: Thu, 8 May 2003 20:55:08 -0400 From: Jim Brown <jpb@sixshooter.v6.thrupoint.net> To: freebsd-doc@freebsd.org Subject: Re: RFC: additions to the article "problem-reports" Message-ID: <20030509005508.GB5716@sixshooter.v6.thrupoint.net> In-Reply-To: <200305081851.41118.linimon@lonesome.com> References: <200305081851.41118.linimon@lonesome.com>
next in thread | previous in thread | raw e-mail | index | archive | help
* Mark Linimon <linimon@lonesome.com> [2003-05-08 19:48]: > While working on my project to classify ports PRs in the database, > I've come across more than my fair share of PRs that are really > badly written. Although the problem-reports article touches on > this to some degree, I really feel that some of the most obvious > mistakes bear further explanation. > > So here's a rough draft of a new section "Tips and tricks for writing > a good Problem Report" to be applied to > /usr/doc/en_US.ISO8859-1/articles/problem-reports/article.sgml. > A few things to note first: > > 1. I've never written SGML before, and I haven't verified this > text's correctness. (Maybe someday I'll learn how to do that, > but right now I am in the middle of this other hackathon, see ... :-) ) > > 2. I've never written this large a chunk of FreeBSD documentation > before, so I won't be offended if either the style is found wanting, > or, in this case, my choice of where to put the changes. (No place > seemed exactly correct.) > > In any case I think this is a necessary, but probably insufficient, > change for the documentation, and I'd like to see what other > people think. Consider it a starting point. > > Mark Linimon (aka "mcl") > Nice job. Fits very neatly into the original document. Thanks to Simon for posting. jpb ===
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030509005508.GB5716>