论文标题
Belle II的用户文档和培训
User documentation and training at Belle II
论文作者
论文摘要
Belle II是一项迅速发展的合作,与一百十九个机构的成员遍布全球。实验的软件开发团队以及软件用户非常分散。加上软件的积极开发,这种权力下放使用户采用最新软件是必不可少但具有挑战性的任务。为了确保文档的相关性,我们采用了编码文档的政策,并配置了一个允许我们将文档绑定到给定版本的网站。为了防止教程变得过时,我们通过单位测试对其进行了介绍。对于用户支持,我们使用一个问答服务,不仅可以减少相同问题的重复,而且还成为专家之间讨论的地方。已经开发了用于不同文档来源的元搜索引擎的原型。为了培训新用户,我们组织了在协作会议上附上的集中式启动kit研讨会。研讨会的材料后来用于自我教育和组织本地培训课程。
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.