Software Documentation Structure
From GlueXWiki
Can have a hierarchy of formality:
- Email: something is available, here is where you check it out
- FAQ: what if I want to do this and so?
- Wiki-Entry/Webpage: reference instructions and information in a permanent place, HOWTO's
- 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.