[Bf-docboard] Manual Reviewing Workflow and Wiki Team

[michelangelomanrique@hotmail.com]

Looks nice imo. It could also be used as basic guideline for bf-docboard-es wiki review.

Thanks!

myHTC

----- Reply message -----
De: "mindrones" <mindrones at gmail.com>
Fecha: vie., dic. 30, 2011 16:44
Asunto: [Bf-docboard] Manual Reviewing Workflow and Wiki Team
Para: "Blender Documentation Project" <bf-docboard at blender.org>

Hi all.

Reviewing Workflow
===================

Finally I took some time to write down the new reviewing workflow,
that has been discussed at length in #blenderwiki:

http://wiki.blender.org/index.php/Meta:Guides/Writer_Guide#Official_Manual_Review_Workflow

I need to modify a bit the templates to manage corner cases (for
example to keep track also of those people that won't respect the
guidelines, and to mark pages as "up to date"), but I think this will
be already much more efficient, and will help us to keep track.

Basically, the idea of a centralized Sandbox (Meta:Sandbox) is gone :)
That place is dead anyway, and it is much better to use our user pages
as personal sandboxes and when we're ready just share our content.
This is what developers do already in GSoC and in general code
documentation, and it just works (when pages are ok they get moved or
merged in the manual).

Everything gets tracked down in
http://wiki.blender.org/index.php/Meta:Wiki_Tasks/Review_2.6_Manual.

When users provide fixes linking their user pages in the relevant manual page:
- we see a 'X' in the "fixes" column
- we review and give feedback to the user in his/her talk page (he
gets notified by mail)
- we or the user update the manual

The major benefit is that we can now examine the Release Notes and:
* if a page with the relevant content exists, but needs adjustment, we
can update the review template and:
** actively find people to fix/write pages
** wait for help from users
* if a page with the relevant content does not exist (think about
motion tracking before it was done), we can easily create that page in
the right place in the manual structure and use the review template to
mark it as empty, add notes etc, and find or wait for writers.


Wiki Team
=========

With this settled down, I think now we can establish a proper Wiki Team.


Reviewers
----------------

I think first of all we need a core of Reviewers.

IMO these people have to be:
* users, with proven experience in blender, actively following the development
* developers, active in documentation realm
Ideally it'd be nice to have one or more reviewers and one developer
per section (modeling, rendering, etc)

These people should know well wiki syntax, templates and guidelines,
and have to:
* add new features in the review templates to 'keep the flow going'
* accept/reject fixes from casual writers and make sure that people
respect the guidelines, deleting unapproved content.
* talk with developers to make sure content is ok and up to date.

Later on I'll mark each section of the manual with the relative Module
owner, using
http://wiki.blender.org/index.php/Template:ModulesOwners
so that everybody can find the person that has developed the feature
explained in a certain page of the manual.


Writers
------------

The more we get, the better of course.
If they work in their own user pages, there's no risk they mess up the
manual somehow.
In my experience, there is a good amount of people starting to edit
the wiki while learning Blender (and mediawiki too): these would not
be ok as reviewers IMO, but very welcome as Writers, if they get
assistance/review from Reviewers.
With a good experience in wiki editing (and blender), Writers can
become Reviewers of course.

--

Regarding the big banner blocking people from editing the Manual: it
can be removed as soon as we'll have a proper Reviewers Team, I guess
we agree?

--

Also, we have discussed at length in #blenderwiki about using an
extension to enforce "rights" in wiki, and probably later we'll use
it, but meanwhile it would be nice to see that we can organize things
and keep them under control without protecting the whole manual.
I don't have a lot of time lately, but I'd mail about this later in January.
Meanwhile, we can discuss and see if there are good ideas about how to
form a good Wiki Team.


Regards,
Luca
_______________________________________________
Bf-docboard mailing list
Bf-docboard at blender.org
http://lists.blender.org/mailman/listinfo/bf-docboard

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.blender.org/pipermail/bf-docboard/attachments/20111230/09205564/attachment.htm