Developer review of documentation

[Matt Zimmerman]

On Tue, Nov 28, 2006 at 11:13:45AM -0000, Matthew East wrote:
> > There is no formal process in place for this yet, as far as I know, but it
> > is needed.  I can arrange developer resources to review documentation
> > for correctness before it is published as official.
> >
> > Doc team: how do you want this to work?
> 
> We did some ad-hoc asking developers to review documentation during the
> Dapper release cycle and it worked well. Here's what I propose we do.
> 
> The documentation team has a number of tasks which it needs to look at
> shortly before string freeze. For example, proof reading, checking menu
> entry consistency, and so on. Asking developers to review key
> documentation for correctness could form part of this process. I suggest
> we do it 2 or 3 weeks before string freeze.
> 
> We'd need to make a list of the key documentation to be reviewed (this
> could include key system documentation, *and* key wiki pages), and
> potentially identify the relevant developers who might be able to lend a
> hand.
> 
> How does that sound as a vague plan?

I think that we need to allow time to revise the documentation if necessary
before string freeze, and ideally there should be multiple batches of review
during the release cycle.  This seems like a logical fit for development
milestones; at each milestone we should arrange review of any new or
substantially changed documentation.

-- 
 - mdz