[RFC] Wiki Style Guide

Martin Pool mbp at sourcefrog.net
Wed Feb 21 21:33:08 GMT 2007


Aaron Bentley wrote:
> Hi all,
> 
> Recently, I reverted a change on the wiki, which is something I dislike
> doing.  The comment on the change was: "I adjusted the verbage to be a
> little more profesional and concise".  But I found the change was not an
> improvement -- the result  more formal and stilted.  There were other
> problems too, so eventually I did revert it.
> 
> I think it would be helpful to have a style guide for the wiki, just as
> we have a HACKING file for bzr.  At least then, we have some kind of
> goal, and we can evaluate writing to see if it meets that goal.
> 
> So here is my attempt at a style guide.  It's what I would like us to
> use, but I'd like to know whether other people agree with it.
> 
> http://bazaar-vcs.org/AaronBentley/StyleGuide
> 
> If the reception is positive, I'll move it into the main site.

I like the style you describe there.  (I think _excessive_ use of "you"
can be bad, but "one" is no better.)

-- 
Martin



More information about the bazaar mailing list