Home Projects Portfolio Dashboard Export PDF Log in

Languages

English
11

Latest Updates

Documenting code, one commit at a time.

research 1 post
×

Improving Developer Experience: Standardizing Project Documentation

Documentation as a First-Class Citizen

Documentation is often the most neglected part of a research codebase. In the ovitos-nanoparticle-analysis project, we recently focused on lowering the barrier to entry by creating a standardized README.md for our example datasets. When scientists and researchers approach a new tool, the ability to quickly verify the analysis pipeline using known,