RFC: additions to the article "problem-reports"

[Jim Brown]

* Mark Linimon <linimon at 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
===