[Bf-docboard] wiki scrum #1

Kesten Broughton solarmobiletrailers at gmail.com
Thu Sep 6 02:23:38 CEST 2012


Hi all,

We had a good meeting on IRC #blenderwiki today.  Brecht posted the log
earlier.
Next scrum will be Sunday morning/afternoon at the close of #blendercoders
scrum (10 am CST?).

First of all, a big thanks to the old guard of reviewers for getting a lot
of the required infrastructure and procedures developed.  I hope there is
no perception that we are undermining those efforts.  What we are here to
do is come up with a workable temporary solution while we are in a
situation of a large backlog of un-reviewed contributions and no
experienced reviewers.

We're not going to fix all problems at once.  Today's scrum was just to set
some 1-week goals to get the ball rolling.

*We will be putting out a hit-list to docboard and blenderartists of a
fraction of the un-reviewed pages each week.  First one will be published
tomorrow for us to devour.*
Post a link to your un-reviewed contribution to have it added to the hopper.

Distilled from the IRC chat is a new trial procedure for contributing and
reviewing:

(a) small changes are allowed by anyone
(b) bigger changes are allowed when reviewed by one other wiki contributor
(admin or not)
 b.1 New contributors/reviewers can start by creating an account.
 b.2 Terry Wallwork will hand-approve new accounts to avoid spam
 b.3 For big changes, a small fraction of pages can be reviewed to ensure
basic style compliance.
     The rest of the pages can be pushed to the manual with a box saying
"This page has not been reviewed.  Please help us make it better.  Do not
use this page to copy style for new pages."
     with a link to style guide and how to get involved / in touch.
 b.4 If not admin, reviewer should at least have recently reviewed   Style
Guidelines <http://wiki.blender.org/index.php/Meta:Guides/Style_Guide>
     and are familiar with
templates<http://wiki.blender.org/index.php/Meta:Guides/Templates>for
formatting.  We will try to have everyone's first review
     re-reviewed to ensure consistency.
 b.5 Reviewers can use the Discussion tab to post review comments.  Post to
docboard when your review is done for re-review :)
 b.6 We are going to try and organize a couple of week-long review-sprints
to clear out the backlog.  If we aren't   making good progress by end of
sept, then we'll have to open the doors to push live according to b.3.
Changes can be reverted through the History tab available when you are
logged in.
(c) a few people pledge to look at recent changes and answer questions on
bf-docdoard
 c.1 We'd like to work towards having head reviewers for each section to
keep the workloads light.  However, it's not required.
So far we have Jim doing BGE, meta-androcto doing addons, brecht and myself
at large.  We need at least another 4 core reviewers willing to contrib 2
hrs/wk at first  to make this fly.

*
Optional Reading:*

Fweeb mentioned that in addition to the style guide, we should have some
templates of best practices to further promote a solid look-and-feel.
The current style-guide gives the form.  This new guide might be more
focused on content, pedagogy etc.  I'd like to see a discussion on this get
distilled and added as a link to the style-guide.  Some general suggestions
I'd make:

Use action phrases.  Assume the user is following along with blender.  Give
activities that can be checked for results when possible.

Get to the punchline as quickly as possible, with a picture or animation
<http://wiki.blender.org/index.php/File:Animated_editing_particles_in_particle_mode.gif>
Show what the user will be able to do.  Then go through the steps to get
there.

Aim your page at a beginner level.  This is especially important if you
want your work reviewed quickly.  If you provide procedures with high level
descriptions of how to do things without following it with the sequence of
UI steps to get there, your reviewer may get stuck or give up.  Please
provide a link to another part of the manual if it exists or supply the
steps in detail yourself.


-- 

Kesten Broughton
President and Technology Director,
Solar Mobile Trailers
kesten at solarmobiletrailers.com
www.sunfarmkitchens.ca <http://www.sunfarmkitchens.ca>
512 701 4209
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.blender.org/pipermail/bf-docboard/attachments/20120905/7fd28afb/attachment.htm 


More information about the Bf-docboard mailing list