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/web page: 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