| CMS Note | |
| Report number | CMS-CR-2009-085 |
| Title | Improving collaborative documentation in CMS |
| Author(s) | Lassila-Perini, Kati (Helsinki Inst. of Phys.) ; Salmi, Leena (Turku U., Dept. French Transl. Stud.) |
| Submitted to | 17th International Conference on Computing in High Energy and Nuclear Physics, Prague, Czech Republic, 21 - 27 Mar 2009 |
| Submitted by | 8 May 2009 |
| Subject category | Detectors and Experimental Techniques |
| Accelerator/Facility, Experiment | CERN LHC ; CMS |
| Free keywords | SOFTWARE ; COMPUTING |
| Abstract | 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 |
| Copyright/License | Preprint: (License: CC-BY-4.0) |
Registro creado el 2009-08-04, última modificación el 2018-06-07
