User documentation and training at Belle II*

¹ The Deutsches Elektronen-Synchrotron
² Ludwig-Maximilians-Universität München
³ Origins Cluster

^* This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY 4.0). The Creative Commons Attribution license allows re-distribution and re-use of a licensed work on the condition that the creator is appropriately credited. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. The terms of the Creative Commons license only apply to original material. Reuse of material from other sources (marked within the Source) such as Diagrams, images, photos and text extracts may require further usage permits from the respective rights holder.
^** e-mail: ilya.komarov@desy.de

Published online: 16 November 2020

Abstract

Belle II is a rapidly growing collaboration with members from one hundred and nineteen institutes spread around the globe. The software development team of the experiment, as well as the software users, are very much decentralised. Together with the active development of the software, such decentralisation makes the adoption of the latest software releases by users an essential, but quite challenging task. To ensure the relevance of the documentation, we adopted the policy of in-code documentation and configured a website that allows us to tie the documentation to given releases. To prevent tutorials from becoming outdated, we covered them by unit-tests. For the user support, we use a question and answer service that not only reduces repetition of the same questions but also turned out to be a place for discussions among the experts. A prototype of a metasearch engine for the different sources of documentation has been developed. For training of the new users, we organise centralised StarterKit workshops attached to the collaboration meetings. The materials of the workshops are later used for self-education and organisation of local training sessions.