Fwd: Report from Cioppino Sprint 2012

--===============8327821795244264029==
Content-Type: multipart/alternative; boundary=Apple-Mail-57-249061542


--Apple-Mail-57-249061542
Content-Type: text/plain;
	charset=WINDOWS-1252;
	format=flowed;
	delsp=yes
Content-Transfer-Encoding: quoted-printable

Begin forwarded message:

> Date: 27 March 2012 5:52:28 PM
> Subject: Report from Cioppino Sprint 2012
> Source: Planet Plone
> Author: David Glick
>
> I've just returned from yet another memorable Plone event, the 2nd =20
> annualCioppino Sprint. For the past 4 days, twelve of us gathered at =20=

> a house in lovely Bodega Bay, CA for a weekend of fun, relaxation, =20
> and giving back to the Plone community.
>
> The theme of the sprint was improving Plone's documentation and =20
> community infrastructure. On the first evening we gathered to =20
> brainstorm tasks,
>

... <cool stuff that was done snipped> ...

Really exciting to see so much effort put into documentation.


>
> One thing that did not happen at the sprint was a clear designation =20=

> of a revitalized documentation team to make sure that our =20
> documentation is well-managed on an ongoing basis. Personally I feel =20=

> that this is a role that is lacking in the community=97Mikko and =20
> others are doing a fantastic job of getting people to add and update =20=

> documentation in the collective developer manual, but I there is a =20
> need for a more focused manual and introductory documentation for =20
> people who are trying to learn Plone development for the first time =20=

> rather than looking up particular tasks or topics=97communally edited =20=

> documentation is inevitably of varying quality and relevance, and =20
> newbies have no way to judge that. There is also a need to make sure =20=

> that old documents are updated or marked as obsolete as appropriate. =20=

> It's not entirely surprising that we've lacked this editing, as it =20
> is a thankless task (everyone can get excited about new =20
> documentation; someone always hates you when you delete something). =20=

> I don't have answers but I hope we can brainstorm as a community =20
> about how to solve this problem (or maybe you can convince me I've =20
> diagnosed the wrong problem.)
>
I've got  a couple of ideas :)

One of the things you said David on #sprint really hit home. Both the =20=

knowledgebase and the c.dm can suffer from the following problem. That =20=

people feel they have the authority to add and correct, but often not =20=

to delete, reorganise and merge content. The consequence is c.dm will =20=

make less and less sense read end to end over time, which is a shame =20
as the real advantage c.dm has over the KB is its "browsability". What =20=

I mean by "browsability" is that I can find what I'm looking for by =20
scrolling up and down and also navigating within the same section, =20
rather than relying purely on google.
I think solving the authority problem is what will prevent c.dm =20
becoming a dumping ground like the KB is.

Here's an idea to kick off discussion:
Have a team of 2-3 who have the authority to consolidate c.dm. This =20
doesn't mean they are the only ones that do that work, just that it =20
gives you someone to ask your proposed restructure is a good idea or =20
not. Think of it as a kind of FWT for c.dm.
As an example I've thought for a long time we should rename the =20
"tutorials" section to "Introduction to Plone's Architecture" and then =20=

move anything in there that doesn't fit to where it does fit, such as =20=

AGX into the content section.  I feel I need to ask permission to make =20=

such a change but it's currently unclear who to ask and hence I've =20
left it. Exactly the behaviour David described. If instead we had a =20
small team with a joint vision of where the manual is going, I'd just =20=

put  my proposed changes to them via this list and they can make that =20=

decision.

Would this work? or is it overkill?

Also, I think another thing that would help is some kind of mechanism =20=

of redirecting from the old location of moved content. Does RTD =20
support this?


--Apple-Mail-57-249061542
Content-Type: text/html;
	charset=WINDOWS-1252
Content-Transfer-Encoding: quoted-printable

<html><body style=3D"word-wrap: break-word; -webkit-nbsp-mode: space; =
-webkit-line-break: after-white-space; "><div><div>Begin forwarded =
message:</div><br class=3D"Apple-interchange-newline"><blockquote =
type=3D"cite"><div><div style=3D"margin-top: 0px; margin-right: 0px; =
margin-bottom: 0px; margin-left: 0px; "><font face=3D"Helvetica" =
size=3D"5" color=3D"#000000" style=3D"font: 18.0px Helvetica; color: =
#000000"><b>Date: </b></font><font face=3D"Helvetica" size=3D"5" =
style=3D"font: 18.0px Helvetica">27 March 2012 5:52:28 =
PM</font></div><div style=3D"margin-top: 0px; margin-right: 0px; =
margin-bottom: 0px; margin-left: 0px; "><font face=3D"Helvetica" =
size=3D"5" color=3D"#000000" style=3D"font: 18.0px Helvetica; color: =
#000000"><b>Subject: </b></font><font face=3D"Helvetica" size=3D"5" =
style=3D"font: 18.0px Helvetica"><b>Report from Cioppino Sprint =
2012</b></font></div><div style=3D"margin-top: 0px; margin-right: 0px; =
margin-bottom: 0px; margin-left: 0px; "><font face=3D"Helvetica" =
size=3D"5" color=3D"#000000" style=3D"font: 18.0px Helvetica; color: =
#000000"><b>Source: </b></font><font face=3D"Helvetica" size=3D"5" =
style=3D"font: 18.0px Helvetica">Planet Plone</font></div><div =
style=3D"margin-top: 0px; margin-right: 0px; margin-bottom: 0px; =
margin-left: 0px; "><font face=3D"Helvetica" size=3D"5" color=3D"#000000" =
style=3D"font: 18.0px Helvetica; color: #000000"><b>Author: =
</b></font><font face=3D"Helvetica" size=3D"5" style=3D"font: 18.0px =
Helvetica">David Glick</font></div><div style=3D"margin-top: 0px; =
margin-right: 0px; margin-bottom: 0px; margin-left: 0px; min-height: =
14px; "><br></div> </div><span class=3D"Apple-style-span" =
style=3D"border-collapse: separate; color: rgb(0, 0, 0); font-family: =
Helvetica; font-style: normal; font-variant: normal; font-weight: =
normal; letter-spacing: normal; line-height: normal; orphans: 2; =
text-align: auto; text-indent: 0px; text-transform: none; white-space: =
normal; widows: 2; word-spacing: 0px; -webkit-border-horizontal-spacing: =
0px; -webkit-border-vertical-spacing: 0px; =
-webkit-text-decorations-in-effect: none; -webkit-text-size-adjust: =
auto; -webkit-text-stroke-width: 0px; font-size: medium; "><div><div =
xmlns=3D"http://www.w3.org/1999/xhtml"><p>I've just returned from yet =
another memorable Plone event, the 2nd annual<a class=3D"external-link" =
href=3D"http://www.coactivate.org/projects/cioppino/project-home" =
style=3D"text-decoration: none; ">Cioppino Sprint</a>. For the past 4 =
days, twelve of us gathered at a house in lovely Bodega Bay, CA for a =
weekend of fun, relaxation, and giving back to the Plone community.<span =
class=3D"Apple-converted-space">&nbsp;</span><br><br>The theme of the =
sprint was improving Plone's<span =
class=3D"Apple-converted-space">&nbsp;</span><b>documentation and =
community infrastructure</b>. On the first evening we gathered to =
brainstorm tasks, </p></div></div></span></blockquote><div><br></div>... =
&lt;cool stuff that was done snipped&gt; =
...</div><div><br></div><div><div>Really exciting to see so much effort =
put into documentation.</div><div><br></div></div><div><br><blockquote =
type=3D"cite"><span class=3D"Apple-style-span" style=3D"border-collapse: =
separate; color: rgb(0, 0, 0); font-family: Helvetica; font-style: =
normal; font-variant: normal; font-weight: normal; letter-spacing: =
normal; line-height: normal; orphans: 2; text-align: auto; text-indent: =
0px; text-transform: none; white-space: normal; widows: 2; word-spacing: =
0px; -webkit-border-horizontal-spacing: 0px; =
-webkit-border-vertical-spacing: 0px; =
-webkit-text-decorations-in-effect: none; -webkit-text-size-adjust: =
auto; -webkit-text-stroke-width: 0px; font-size: medium; "><div><div =
xmlns=3D"http://www.w3.org/1999/xhtml"><p><br></p><p>One thing that did =
not happen at the sprint was a clear designation of a revitalized =
documentation team to make sure that our documentation is well-managed =
on an ongoing basis. Personally I feel that this is a role that is =
lacking in the community=97Mikko and others are doing a fantastic job of =
getting people to add and update documentation in the collective =
developer manual, but I there is a need for a more focused manual and =
introductory documentation for people who are trying to learn Plone =
development for the first time rather than looking up particular tasks =
or topics=97communally edited documentation is inevitably of varying =
quality and relevance, and newbies have no way to judge that. There is =
also a need to make sure that old documents are updated or marked as =
obsolete as appropriate. It's not entirely surprising that we've lacked =
this editing, as it is a thankless task (everyone can get excited about =
new documentation; someone always hates you when you delete something). =
I don't have answers but I hope we can brainstorm as a community about =
how to solve this problem (or maybe you can convince me I've diagnosed =
the wrong problem.)</p></div></div></span></blockquote><div>I've got =
&nbsp;a couple of ideas :)</div><div><br></div><div>One of the things =
you said David on #sprint really hit home. Both the knowledgebase and =
the c.dm can suffer from the following problem. That people feel they =
have the authority to add and correct, but often not to delete, =
reorganise and merge content. The consequence is c.dm will make less and =
less sense read end to end over time, which is a shame as the real =
advantage c.dm has over the KB is its "browsability". What I mean by =
"browsability" is that I can find what I'm looking for by scrolling up =
and down and also navigating within the same section, rather than =
relying purely on google.</div><div>I think solving the authority =
problem is what will prevent c.dm becoming a dumping ground like the KB =
is.</div><div><br></div><div>Here's an idea to kick off =
discussion:</div><div>Have a team of 2-3 who have the authority to =
consolidate c.dm. This doesn't mean they are the only ones that do that =
work, just that it gives you someone to ask your proposed restructure is =
a good idea or not. Think of it as a kind of FWT for c.dm.</div><div>As =
an example I've thought for a long time we should rename the "tutorials" =
section to "Introduction to Plone's Architecture" and then move anything =
in there that doesn't fit to where it does fit, such as AGX into the =
content section. &nbsp;I feel I need to ask permission to make such a =
change but it's currently unclear who to ask and hence I've left it. =
Exactly the behaviour David described. If instead we had a small team =
with a joint vision of where the manual is going, I'd just put &nbsp;my =
proposed changes to them via this list and they can make that =
decision.&nbsp;</div><div><br></div><div>Would this work? or is it =
overkill?</div><div><br></div><div>Also, I think another thing that =
would help is some kind of mechanism of redirecting from the old =
location of moved content. Does RTD support =
this?</div></div><br></body></html>=

--Apple-Mail-57-249061542--


--===============8327821795244264029==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

------------------------------------------------------------------------------
This SF email is sponsosred by:
Try Windows Azure free for 90 days Click Here 
http://p.sf.net/sfu/sfd2d-msazure
--===============8327821795244264029==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs

--===============8327821795244264029==--