Adding enhancements to the NSCL DAQ

This script describes the steps taken to implement an enhancement work item in the NSCL data acquisition system. Enhancements are defined as the addition of functionality to existing programs or libraries or the creation of new programs or libraries.

  1. Claim the item from the iteration planning document by entering you name and the date started. If your name is not Ron Fox, inform mailto:fox@nscl.msu.edu you have started working on this work item.
  2. Contact the stakeholders for the work item to ensure you understand what is wanted and produce a short (1 page or less) summary clarifying what the item is. How the finished item will appear to the user and a stab at how it will be accomplished developmentally. Put this document online and link it into the current iteration plan document.
  3. Use test driven development to implement the work item.
  4. Document for the user using Hyperlatex, and internally using Doxygen
  5. Peform integration testing and early adopter testing if possible/appropriate
  6. Install the user and internals documents on http://docs.nscl.msu.edu/daq linked to http://docs.nscl.msu.edu
  7. Commit your source file changes and additions.
  8. Close the item on the iteration plan by entering the completion date. If your name is not Ron Fox inform mailto:fox@nscl.msu.edu of the completion of this work item.

References:

  1. K. Beck Test Driven Development By Example Addison Wesley 2003 ISBN 0-321-14663-0
  2. cppunit available on the linux systems documented at: http://cppunit.sourceforge.net/cppunit_cookbook.html#cppunit_cookbook
  3. tcltest available on the linux systems documented at: man tcltest
  4. Hyperlatex is available on the linux systems. Documentation at: http://www.hyperlatex.fr.fm/hyperlatex.html
  5. Doxygen is available on the linux systems. Documented at: http://www.stack.nl/~dimitri/doxygen/manual.html