Pythondocs.info : collaborative Python documentation project

Brad Allen bolderaft at gmail.com
Sun Sep 17 15:21:29 EDT 2006


Kay Schluehr wrote:

> Personally, I never found the Python docs particular bad. It is
> rewarding to write good documentation because documentation has
> different aspects i.e. introductory/tutorial, exhaustive/manual and
> design documentation aspects. Not to mention cookbook recipes.
>
> I also observe that the discussion about Python docs is very tool
> centered and my question to all the people who believe to improve the
> Python docs by converting old tuturials into Wikis is that: what are
> the precise requirements? Will an internet connection soon be necessary
> to know how the sys module works?

+1 that downloadability is an important requirement; wiki does not
preclude this
-1 on wiki as the only approach; wiki could be an adjunct to officially
managed docs

> Are there any thoughts about
> integrating 3rd party module/package documentation with the docs of the
> stdlib / tutorial / language ref etc.so that they finally find their
> logical place in the system ?

This could become a natural progression once a full-featured
documentation system is in place.

> Are there any intentions to create an
> informational PEP regarding documentation in any forseeable future or
> shall documentation projects continue to start in the wild?

Sounds like a great idea. We should probably do more brainstorming and
discussion about the particulars before someone spends a lot of time
writing a PEP. We could create a separate topic in this forum, titled
something like 'Ideas for a new PEP on Python.org documentation
structure, UI, and processes'.




More information about the Python-list mailing list