On Wed, 13 Feb 2013 18:07:22 +0100, Christian Tismer
I think before getting people to work through long and complete documentation, it is probably easier to wake their interest by something like "Hey, are you doing things this way?" And then there is a short, concise list of bad and good things, maybe even dynamic as in WingWare's "Wing Tips" or any better approach.
From that easily reachable, only a few pages long tabular collection of short hints and caveats there could be linkage to the existing, real documentation that explains things in more detail. Maybe that could be a way to get people to actually read.
There used to be a HOWTO with this goal, but its opinions were considered outdated and/or contentious, and it was deleted: http://docs.python.org/2.6/howto/doanddont.html --David