| 8 | | * General Documentation needs to be reviewed to verify for readability and that it matches the actual functionality (does pressing the button do what it says) |
| 9 | | * Model docs need to be reviewed for |
| 10 | | * Clarity |
| 11 | | * That units on parameters are correct and properly formatted |
| 12 | | * That Equation matches what the code does |
| 13 | | * Completeness - elements of documentation are: |
| 14 | | * title |
| 15 | | * tool tip |
| 16 | | * Parameter table |
| 17 | | * Paragraph describing what the function does |
| 18 | | * equation used |
| 19 | | * Fig obtained when model is run with default parameters as listed in table above |
| 20 | | * Reference |
| 21 | | * NEW REQUIREMENT |
| 22 | | * Added by: name, ON: date |
| 23 | | * checked by: name, ON: date |
| 24 | | These last can be added by "DANSE" if old models with no name, or source if imported from other package, etc. |
| 41 | | * Remove all reference to term perspective which confuses users -- replace with "Analysis" or other appropriate wording. |
| 42 | | * Add a help topic on menu items (go through menu list) |
| 43 | | * restructure tree to |
| 44 | | * collapse tool help under a top level Tools entry |
| 45 | | * collapse Fitting, Pr an invariant into an Analysis heading |
| | 24 | * General help documentation |
| | 25 | * Remove all reference to term perspective which confuses users -- replace with "Analysis" or other appropriate wording. |
| | 26 | * Add a help topic on menu items (go through menu list) |
| | 27 | * restructure tree to |
| | 28 | * collapse tool help under a top level Tools entry |
| | 29 | * collapse Fitting, Pr an invariant into an Analysis heading |
| | 30 | * 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) |
| | 31 | * Model help documentation |
| | 32 | *review for all models for |
| | 33 | * Clarity |
| | 34 | * That units on parameters are correct and properly formatted |
| | 35 | * That Equation matches what the code does |
| | 36 | * Completeness - elements of documentation are: |
| | 37 | * title |
| | 38 | * tool tip |
| | 39 | * Parameter table |
| | 40 | * Paragraph describing what the function does |
| | 41 | * equation used |
| | 42 | * Fig obtained when model is run with default parameters as listed in table above |
| | 43 | * Reference |
| | 44 | * NEW REQUIREMENT |
| | 45 | * Added by: name, ON: date |
| | 46 | * checked by: name, ON: date |
| | 47 | * Can us name such as "DANSE" if old models with no name of who added, or source if imported from other package, etc. |
