70 likes | 211 Views
Discussion on documentation. Joel Closier CERN LHCb Computing Workshop 2 1st Ma y 2013. LHCb Documentation. For the computing part, LHCb project used same layout. Code documentation. Tools in used to generate documentation: Doxygen Sphynx No doc for Ganga ???.
E N D
Discussion on documentation Joel Closier CERN LHCb Computing Workshop 21st May 2013
LHCb Documentation • For the computing part, LHCb projectusedsamelayout LHCb Computing Workshop – J. Closier
Code documentation • Tools in used to generate documentation: • Doxygen • Sphynx No doc for Ganga ??? LHCb Computing Workshop – J. Closier
Documentation of the code • Good Documentation for LHCb Applications • Code view, navigation • Graph of dependencies LHCb Computing Workshop – J. Closier
Documentation of code • LHCbDIRAC exemple ishalf – half LHCb Computing Workshop – J. Closier
FrequentlyAsked Questions • Today: • FAQ exists for someproject • FAQ spreadacrossseveral support • Several format (mainlytwiki) LHCb Computing Workshop – J. Closier
FAQ : proposal • Tomorrow: • One single place for all the LHCb FAQ • Allow categories • Could be extended to LHCb in general if needed and useful LHCb Computing Workshop – J. Closier