Ferhat Elmas — Passionate Developer

The Importance of the Documentation

22 April ’13

As a Django newbie, I am very puzzled with the number of independent pluggable applications in Django world. In a web application, first thing to do is to get users so managing registration.

If we do a basic search for registration: $ pip search registration | gawk -e '{print $1}' | wc -l

It returns 77 applications at the time of writing. Not all of them are Django related and if we filter them by Django, result set goes down to 37 which is still a high number of applications.

There is no possibility to check each one of them since this is just one step of implementation. Along the way of development, we will need a bunch of other applications like social integrations, profile management, forms, etc. This list goes long and manual checking of applications which ones fit better into the project doesn't scale.

We don't invent the wheel and ask at the places where experienced people hang out, #django on freenode, stackoverflow, google plus(yes, in communities, there are a lot of helpful geeks).

After my short journey and humble observations, I realized that most preferred applications aren't the ones that do the job far better than others but the ones that include detailed documents and a toy example program to show the usage. There may be better alternative which is more stable and coded more modular but without documentation, activation energy to use it is so high.

Documentation and implementation aren't orthogonal, on the contrary they are supplementary parts of each other. It's not finished until both are complete.