Rework Proposal

Jump to bottom

Ricardo Ferraz Leal edited this page Apr 1, 2019 · 7 revisions

There are two types of Help currently: Documentation and Tutorial.

==General Thoughts==

Both should be available off line, online, and as part of the GUI application
Above means that sphinx should build a PDF as well HTML output #510
Re-order Menu list to move Analysis next to the perspective menu item it has chosen (currently only Fitting has a separate menu) #515
Rename Tool to Tools #515

ISSUES:

Model parameter names convention seems wrong?
how do we deal with changing screen shots?

==Tutorial==

Should redo completely around example data in SasView
Tutorials for each topic that can then be bundled together if desired
- Fitting
  - 1D #518
  - 2D #519
  - constrained #520
  - simultaneous #521
  - Batch #522
- Pr #516
- Invariant #517

==Documentation==

General help documentation
- Remove all reference to term perspective which confuses users --- replace with "Analysis" or other appropriate wording. [#513](http://trac.sasview.org/ticket/513 "enhancement: Remove all references to "perspective" from User Documentation (closed: fixed)")
- Add a help topic on menu items (go through menu list) #512
- restructure tree to #511
  - collapse tool help under a top level Tools entry
  - collapse Fitting, Pr an invariant into an Analysis heading
- All of it should then be reviewed to verify for readability and that it matches the actual functionality (does pressing the button do what it says) #514
Model help documentation #19
- review for all models for
  - Clarity
  - That units on parameters are correct and properly formatted
  - That Equation matches what the code does
  - Completeness - elements of documentation are:
    - title
    - tool tip
    - Parameter table
    - Paragraph describing what the function does
    - equation used
    - Fig obtained when model is run with default parameters as listed in table above
    - Reference
    - NEW REQUIREMENT
      - Added by: name, ON: date
      - checked by: name, ON: date
      - modified by: name, ON: date
      - Can us name such as "DANSE" if old models with no name of who added, or source if imported from other package, etc.