Cargando…

Improving collaborative documentation in CMS

Complete and up-to-date documentation is essential for efficient data analysis in a large and complex collaboration like CMS. Good documentation reduces the time spent in problem solving for users and software developers. The scientists in our research environment do not necessarily have the interes...

Descripción completa

Detalles Bibliográficos
Autores principales: Lassila-Perini, Kati, Salmi, Leena
Lenguaje:eng
Publicado: 2009
Materias:
Acceso en línea:http://cds.cern.ch/record/1196150
_version_ 1780917066351509504
author Lassila-Perini, Kati
Salmi, Leena
author_facet Lassila-Perini, Kati
Salmi, Leena
author_sort Lassila-Perini, Kati
collection CERN
description Complete and up-to-date documentation is essential for efficient data analysis in a large and complex collaboration like CMS. Good documentation reduces the time spent in problem solving for users and software developers. The scientists in our research environment do not necessarily have the interests or skills of professional technical writers. This results in inconsistencies in the documentation. To improve the quality, we have started a multidisciplinary project involving CMS user support and expertise in technical communication from the University of Turku, Finland. In this paper, we present possible approaches to study the usability of the documentation, for instance, usability tests conducted recently for the CMS software and computing user documentation
id cern-1196150
institution Organización Europea para la Investigación Nuclear
language eng
publishDate 2009
record_format invenio
spelling cern-11961502019-09-30T06:29:59Zhttp://cds.cern.ch/record/1196150engLassila-Perini, KatiSalmi, LeenaImproving collaborative documentation in CMSDetectors and Experimental TechniquesComplete and up-to-date documentation is essential for efficient data analysis in a large and complex collaboration like CMS. Good documentation reduces the time spent in problem solving for users and software developers. The scientists in our research environment do not necessarily have the interests or skills of professional technical writers. This results in inconsistencies in the documentation. To improve the quality, we have started a multidisciplinary project involving CMS user support and expertise in technical communication from the University of Turku, Finland. In this paper, we present possible approaches to study the usability of the documentation, for instance, usability tests conducted recently for the CMS software and computing user documentationCMS-CR-2009-085oai:cds.cern.ch:11961502009-05-08
spellingShingle Detectors and Experimental Techniques
Lassila-Perini, Kati
Salmi, Leena
Improving collaborative documentation in CMS
title Improving collaborative documentation in CMS
title_full Improving collaborative documentation in CMS
title_fullStr Improving collaborative documentation in CMS
title_full_unstemmed Improving collaborative documentation in CMS
title_short Improving collaborative documentation in CMS
title_sort improving collaborative documentation in cms
topic Detectors and Experimental Techniques
url http://cds.cern.ch/record/1196150
work_keys_str_mv AT lassilaperinikati improvingcollaborativedocumentationincms
AT salmileena improvingcollaborativedocumentationincms