[Tutor] Community documentation framework?
Mike.Hansen at atmel.com
Tue Aug 8 18:49:22 CEST 2006
From: tutor-bounces at python.org [mailto:tutor-bounces at python.org]
On Behalf Of Bob Nienhuis
Sent: Sunday, August 06, 2006 3:56 PM
To: tutor at python.org
Subject: [Tutor] Community documentation framework?
Have you had the experience of finding a nifty bit of code on
web, trying it out, and then discovering that technique
only worked in version X.YY, or requires module Z that
is no longer available?
Well perhaps we can address this situation.
I would like to see an online system that facilitates
the collaborative production, cataloging and updating of
community documentation. See an article, "Rethinking Community
Documentation" by Andy Oram
Features I would like to see:
A Wikipedia-like capacity for community
of documentation submissions.
Database for cataloging available packages, modules, FAQs,
tutorials, cookbook code fragments etc. Should have capacity
developers to add and others to add to their contributions.
Oram suggests a rating system for submissions so users can
the quality of submissions, and point to parts that need
Might use TurboGears, Django AJAX or other web framework?
I think main Python documentation is great, but there is a lot
of stuff out there that isn't documented so well, or needs
updating. This project is intended to adress that need.
What would you like to see?
You might take a look at
More information about the Tutor