DOE PAGES title logo U.S. Department of Energy
Office of Scientific and Technical Information

Title: Breaking the silos: The art documentation suite

Abstract

The art event-processing framework is used by almost all new experiments at Fermilab, and by several outside of Fermilab. All use art as an external product in the same sense that the compiler, ROOT, Geant4, CLHEP and boost are external products. The art team has embarked on a campaign to document art and develop training materials for new users. Many new users of art have little or no knowledge of C++, software engineering, build systems or the many external packages used by art or their experiments, such as ROOT, CLHEP, HEPPDT, and boost. To effectively teach art requires that the training materials include appropriate introductions to these topics as they are encountered. Experience has shown that simply referring readers to the existing native documentation does not work, too often a simple idea that they need to understand is described in a context that presumes prerequisites that are unimportant for a beginning user of art. There is the additional complication that the training materials must be presented in a way that does not presume knowledge of any of the experiments using art. Finally, new users of art arrive at random times throughout the year and the training materials must allow themmore » to start to learn art at any time. This presentation will explain the strategies adopted by the art team to develop a documentation suite that complies with these boundary conditions. It will also show the present status of the documentation suite, including feedback the art team has received from pilot users.« less

Authors:
 [1]
  1. Fermi National Accelerator Lab. (FNAL), Batavia, IL (United States)
Publication Date:
Research Org.:
Fermi National Accelerator Lab. (FNAL), Batavia, IL (United States)
Sponsoring Org.:
USDOE Office of Science (SC), High Energy Physics (HEP)
OSTI Identifier:
1250785
Report Number(s):
FERMILAB-CONF-15-639-CD
Journal ID: ISSN 1742-6588; 1414010
Grant/Contract Number:  
AC02-07CH11359
Resource Type:
Accepted Manuscript
Journal Name:
Journal of Physics. Conference Series
Additional Journal Information:
Journal Volume: 664; Journal Issue: 7; Conference: 21st International Conference on Computing in High Energy and Nuclear Physics, Okinawa (Japan), 13-17 Apr 2015; Journal ID: ISSN 1742-6588
Publisher:
IOP Publishing
Country of Publication:
United States
Language:
English
Subject:
97 MATHEMATICS AND COMPUTING

Citation Formats

Kutschke, Robert K. Breaking the silos: The art documentation suite. United States: N. p., 2015. Web. doi:10.1088/1742-6596/664/7/072030.
Kutschke, Robert K. Breaking the silos: The art documentation suite. United States. https://doi.org/10.1088/1742-6596/664/7/072030
Kutschke, Robert K. Wed . "Breaking the silos: The art documentation suite". United States. https://doi.org/10.1088/1742-6596/664/7/072030. https://www.osti.gov/servlets/purl/1250785.
@article{osti_1250785,
title = {Breaking the silos: The art documentation suite},
author = {Kutschke, Robert K.},
abstractNote = {The art event-processing framework is used by almost all new experiments at Fermilab, and by several outside of Fermilab. All use art as an external product in the same sense that the compiler, ROOT, Geant4, CLHEP and boost are external products. The art team has embarked on a campaign to document art and develop training materials for new users. Many new users of art have little or no knowledge of C++, software engineering, build systems or the many external packages used by art or their experiments, such as ROOT, CLHEP, HEPPDT, and boost. To effectively teach art requires that the training materials include appropriate introductions to these topics as they are encountered. Experience has shown that simply referring readers to the existing native documentation does not work, too often a simple idea that they need to understand is described in a context that presumes prerequisites that are unimportant for a beginning user of art. There is the additional complication that the training materials must be presented in a way that does not presume knowledge of any of the experiments using art. Finally, new users of art arrive at random times throughout the year and the training materials must allow them to start to learn art at any time. This presentation will explain the strategies adopted by the art team to develop a documentation suite that complies with these boundary conditions. It will also show the present status of the documentation suite, including feedback the art team has received from pilot users.},
doi = {10.1088/1742-6596/664/7/072030},
journal = {Journal of Physics. Conference Series},
number = 7,
volume = 664,
place = {United States},
year = {Wed Dec 23 00:00:00 EST 2015},
month = {Wed Dec 23 00:00:00 EST 2015}
}