Difference between revisions of "Software Documentation Structure"

Revision as of 14:40, 22 March 2010

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