Israel Saeta Pérez schrieb:
> On Sat, Nov 22, 2008 at 10:06 PM, Russ Ferriday wrote:
>> I've been lurking on this list for ages, and it's time to step up...
>
> Welcome!
>
>> On 22 Nov 2008, at 04:31, Dylan Jay wrote:
>>
>> Is it possible to ask who in this whole debate actually works at the code
>> level with Plone?
I do.
> Snippets of code are a different type of documentation from what we
> have currently at plone.org.
Howtos are not far away (even if the currents organization of phc isn't
suited for masses of them) and Mikko collected receipts here:
http://plone.org/documentation/tutorial/manipulating-plone-objects-programmatically> I agree with you - they're really helpful
> for developers. But I would be very scared if I were a newcomer,
> browsed to plone.org/documentation and found something like that
>
http://code.activestate.com/recipes/langs/python/>
> Even if you're an intermediate developer, you often need more
> comprehensive documentation than quick recipes/tips/solutions,
> specially reference documentation. See, for example, the Zope
> Developer's Guide or The Zope Book.
>
> So I think our best bet to satisfy all needs would be keeping the
> current documentation model/process for (hoped) up-to-date manuals,
> references and most-common howtos, and create an open-editing web
> space to collect quick informal recipes.
I like the idea of "official" documentation and lesser controlled
documentation in an open-editing space. That's what happens in Drupal
now, someone posted a link to their docteam-list some days ago.
Receipts and other documentation should at least contain a "Works for
Plone x.y" annotation. Even if almost all new receipts target plone 3.1,
this open-edit space would have to be maintained. If we had hundreds of
unsorted receipts now ranging from Plone 2.0 to 3.1 it would be insane.
Good dokumentation can be moved into the right place in the "official"
part. Bad documentation should be removed.
> Would everybody be happy with such a solution? I hope so.
I would be if we have the capacities to maintain this in the long run.
We could end up with plenty of docs that are incomplete, missleading,
outdated or plain wrong. If we can control that receips are really
helpful. If we can't, we have a good chance to discourage new
developers. I tried many code snippets in the first month I used Plone
that really frustrated me.
..Carsten
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs