Software Documentation Structure

From GlueXWiki
Jump to: navigation, search

Can have a hierarchy of formality:

  1. Email: something is available, here is where you check it out
  2. FAQ: what if I want to do this and so?
  3. Wiki-Entry/Webpage: reference instructions and information in a permanent place, HOWTO's
  4. GlueX Note: user manual, methods description

Notes:

  • Do not have a FAQ. Should we?
  • Every detector should have at least one note on its reconstruction algorithm.
  • Every major software system should have a note describing it.
Retrieved from "https://halldweb1.jlab.org/wiki/index.php?title=Software_Documentation_Structure&oldid=17976"