Generic documentation content

[SimonHeybrock]

Related to scipp/esssans#129.

Where should this go? A page in the user-guide? A new section, similar to Recipies in Sciline?

Content to consider for inclusion

• Plotting event data workflow results (reason: All our workflows will support event-mode).

[SimonHeybrock]

I have been thinking about this a bit and I wonder if we should first focus more on improving the UX further? Bad UX (or lack of helper widgets, see #28) will result in a lot of things that need documentation. Furthermore, until the UX and interfaces are closer to final, it is not clear which are the most relevant bits to be documented, so we may waste a lot of time documenting things which later turn out to become irrelevant.

Thoughts?

[SimonHeybrock]

More partially related notes from book club on documentation:

• Currently the notebooks mix many purposes. This is a problem:
  • Some (probably insufficient) explanation of how code works.
  • Some (probably insufficient) explanation of data reduction (math).
  • Used to actually reduce data
• We probably want to be very clear about the purpose of each notebook. Make two workflows, one with explanation, one for production?
• Move common sections into dedicated notebooks (example: how to compute intermediate results). <- This is mostly generic, as the original issue. Can it move to ESSreduce?