On Tuesday 14 February 2006 19:38, Malcolm Tredinnick wrote:
> Having been tooling around with Django for some months now, primarily
> on little projects for my own use, I wanted to write up some of the
> things I've learnt. I actually like doing documentation, so I want to
> do something useful here. I thought it would be nice to take a couple
> of project ideas and produce some tutorial-like documents describing
> how to implement them in Django from start to (more or less) finish.

Be careful about what you choose to document.  Django's magic-removal branch 
will be a significant change and there may be other backwards incompatible 
changes before Django 1.0 is born.  The project you choose to document may be 
prone to deprecation between now and when Django reaches 1.0.  On a more 
serious note, your documentation may be misleading if deprecated and still 
publicly available a few months from now.  If not careful, your efforts may 
not be as helpful as you'd like.

If none of the Django deities chime in on this, you might ask about it on the 
django-developers list.

Kudos to you for offering to share your efforts.

Eric.

Reply via email to