Docs QA
Jesús Franco
tezcatl at fedoraproject.org
Thu Nov 11 22:32:16 UTC 2010
> On Thu, Nov 11, 2010 at 8:16 PM, Paul W. Frields <stickster at gmail.com>wrote:
>
> > On Wed, Nov 10, 2010 at 04:09:28PM -0600, Jesús Franco wrote:
> > > On Wed, Nov 10, 2010 at 09:40:41PM +0100, Travis Whitlock wrote:
> > > > I would suggest attempting to have an independent reviewer. Meaning a
> > > > member of the docs team that ideally has not worked on the section they
> > are
> > > > reviewing. Familiarity with a document is usually the best way to
> > overlook
> > > > mistakes.
> > >
> > > It would be a great way to letting 'shy' people like me, not brave
> > > enough to mess with the work done, but able to read and test some
> > > things and reporting some issues, actually contributing to the
> > > project.
> > >
> > > I'm glad with this *huge* proposal. I'm going to take it to
> > > translators too, because sometimes the translators don't use
> > > terminology dictionaries (nor peer reviews), and leads to confussion
> > > when instead of using the terms specific for the matter of the
> > > documentation, they use generic translations, missing the sense of the
> > > original author.
> >
> > This is a great idea. Most dead-tree technical books out there
> > (including the ones about Fedora) get independent technical review.
> > Having done this myself, I can tell you it definitely helps the
> > finished product immensely. We probably have other lurking people who
> > would put a hand up and say, "I can test <N> chapters of this book for
> > you."
> > ---
> > Paul W. Frields http://paul.frields.org/
On Thu, Nov 11, 2010 at 09:19:03PM +0100, Travis Whitlock wrote:
> I'm not committed to anything right now and I am looking for something to
> do. Let me know if anyone wants to put their work under my scrutiny :)
I witnessed how *fast* (really fast) can be the response to
documentation and localization bugs.
my example: https://bugzilla.redhat.com/show_bug.cgi?id=651650
This said, i think we have three options:
* Reporting in Bugzilla the errors you found.
* Writing to the mailing list which chapters are you doing the review.
* Having a wiki page showing which chapter are checking and who.
Again, it gives a lot of lurkers, the chance for jumping on the train
and beginning to contribute.
I'm sure it would be a great opportunity to some gardening on pages
for new contributors. I'll work by this night on a proposal, and
waiting for more ideas on the list.
Jesús Franco
http://identi.ca/tzk
http://fedoraproject.org/wiki/User:Tezcatl
More information about the docs
mailing list