flextool icon indicating copy to clipboard operation
flextool copied to clipboard

Improving the documentation

Open jkiviluo opened this issue 2 years ago • 0 comments

Observations based on a test user

  • [x] explain the point of init.sql. What 'init' means. The different ways how to go through the tutorial
  • [x] explain the basic functioning of Toolbox (choosing alternatives, how to edit data, how to filter data)
  • [x] say where data is for each thing visible in figure and text
  • [x] confusing instructions -- too much assumed to be known. Is the solution to make a lot longer tutorial or a lot simpler tutorial?
  • [x] explain where the results are
  • [x] also what results you will get
  • [x] To database editor in brief: what classes, objects, relationships and paragraphs. scenarios and alternatives.
  • [ ] Explain curtailment penalty (how it should be calculated after the model run)
  • [ ] Prioritization of what you need when you first start working with Spine Toolbox / FlexTool project
  • [x] Move db editor, browser editor etc. to own pages (browser editor to web-interface docs)
  • [ ] Explain how to make model faster and how integers affect model (startups and ramps too)

jkiviluo avatar Aug 31 '22 10:08 jkiviluo