Documentation on OPAVAR

1
Offline documentation

• Documentation on OPAVAR
• Scattered between journal articles and technical
  reports
• There is no users manual
• Documentation on NEMOVAR (nothing yet)
• Some overlap with OPAVAR so documentation can be
  recycled
• New features will need to be documented
• It is especially important to have a reference
  when others start to use the code (cf. NEMO no
  reference yet!)

2
Offline documentation

• What strategy do we take?
• Those responsible for a particular development
  (e.g., an observation operator) should also be
  responsible for the documentation (description of
  basic algorithms, code interfaces)
• Code modifications should ideally be accompanied
  with an update to the documentation.
• How do we organize the documentation?
• Scientific articles
• Technical reports with algorithmic details
• Technical reports with code details
• User manual
• We should start planning the documentation of the
  NEMOVAR outer loop developments (observation
  operators) as a technical report. When? With what
  observation operators/data bases?