Particle #physics involves a great amount of specialized purpose-built software developed and maintained by the community. Often, it is initially written by individual researchers for their own research project, and later made available and adapted for further applications. This entails that the documentation and usability is not always at the level of commercial software. In order to improve the situation, there will be a Docathon (hackathon, but focused on documentation) held at Warwick in March. Ideal for physicists who want to learn modern, efficient software documentation and increase the usefulness of their software for the wider community! https://indico.global/event/16510/
Discussion
Loading...
@paulbalduf
About 4 years ago I made the tradition from particle physics to industry. Documentation in PP was haphazard, written by grad students, self-contradictory, and badly maintained.
The internal documentation for our company’s robot code is so so much worse. It’s assumed implicitly that you are sitting next to an expert with 8 years experience. When you can find it at all.