[IMP-dev] IMP documentation & tutorials by the people

[Barak Raveh <>]

Hey guys,

Here is a very tempting suggestion, which might benefit all of us in the long run, but will require some group effort :)ÂAs we all know, though lots ofÂefforts have been made to document IMP, getting started on IMP development or usage is (quite naturally) still somewhat far from obvious (missing or outdated documentation or examples, no tutorials etc.).ÂSo - the idea is that if we team up, we can improve the documentation and write tutorials in relatively small effort, benefiting new users and developers, and surely also old ones.ÂWe can then have peer-reviewing of the resulting documentation (e.g., one team checking the documentation / tutorials written by another team).

Here are some initial ideas Daniel and I had in mind, and feel free to add suggestions:

* A team will make sure the Getting Started and Developer Guide are up to date, make them even friendlier and extend them further

* Other teams will validate existing example codes, add missing example codes, and most important, write friendly tutorials on how to accomplish common IMP tasks (both development, e.g., "how to write new code for Monte-Carlo simulation with restraints", and usage e.g. "how to dock from EM")Â

* Perhaps one team can also go over some key classes and improve their code documentation, especially in the core / kernel / base / atom modules.

Ok, Who's in? :) We will try to keep the task relatively smalls, so that they can be done in 1-2 working days.Â

Cheers,

Barak