CS Document 5545-v3
Breaking the Silos: The art Documentation Suite
- Public document
- 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 refering 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 we have received from pilot users.
- Associated with Events:
- held on 13 Apr 2015