<div dir="ltr">Hi all, <div>So pleased with the great throughput we're seeing with our new core reviewers on docs. Thanks all!</div><div><br></div><div>I noticed that the openstack-dev list has pointed to a wiki page for review guidelines for all code projects to follow at <a href="https://wiki.openstack.org/wiki/ReviewChecklist">https://wiki.openstack.org/wiki/ReviewChecklist</a>. We definitely have similar guidelines and consistency and tests are at the heart of it. But I think we can build some more guidelines for reviews for docs, since we are a bit different. We need speed and accuracy to prevail, while holding a line for quality and consistency considerations.</div>

<div><br></div><div>Writers become better writers by continually editing and refining. I think we do a good job at this, but we are also serving a non-writing set of collaborators. So how about some additional guidelines for our reviewers?</div>

<div><br></div><div><div style="font-family:arial,sans-serif;font-size:13px"> - If you have nits to pick, fix them yourself rather than making the contributor do it, unless the contributor prefers to learn by being edited (I have seen this over and over in my writing, that I'm a better writer after entering someone else's edits).</div>

<div style="font-family:arial,sans-serif;font-size:13px"> - Reviewers, let's constantly police ourselves for over-nitpicking when technical accuracy is our main goal.</div><div style="font-family:arial,sans-serif;font-size:13px">

- Let's still recognize the quality rise that better editing gives us.</div></div><div style="font-family:arial,sans-serif;font-size:13px">- As the release gets closer, speed matters over editing as long as it's consistent.</div>

<div style="font-family:arial,sans-serif;font-size:13px"><br></div><div style="font-family:arial,sans-serif;font-size:13px">There are a few things going on to help with this balancing act:</div><div style="font-family:arial,sans-serif;font-size:13px">

- The O'Reilly custom edit means we can reliably believe that all nits have been picked, but we also have to ensure crap doesn't nudge in. :)</div><div style="font-family:arial,sans-serif;font-size:13px">- I'm having a Rackspace editor work with a Rackspace writer to do a deep edit on the End User Guide, that patch will land soon.</div>

<div style="font-family:arial,sans-serif;font-size:13px">- I'm seeking ways to get a style guide beyond just our Conventions wiki page to help us all edit with confidence that consistency will prevail.</div><div><br>
</div>
<div>Thoughts? I'll put this info in a wiki page for reviewer guidance once we all agree on the basics. </div><div><br></div><div>Thanks,</div><div>Anne</div><div><br></div></div>