Update Reflectometry GUI Docs

[Owen Arnold]

1) Needs a "What is this interface for section": Something like:

"This user interface is for managing batch processing of data reduction for reflectometry data. The algorithm is built upon ReflectometryReductionOne. See this algorithm for expansion of the data reduction steps. (reuse workflow diagram here). The GUI works hard to establish instrument level defaults, so that the number of mandatory options are minimal. Conversely, you may provide overrides for anything in the standard algorithm. An optional post-processing step allows you to stitch groups of results together, and plot them, or export them to your favourite data format. Pre-processing and transfer functionality allows data to be imported from various data archives and pre-assembles the batch table."

2) Link to the data did not get generated properly

3) "This is the data before processing." to "This is the data before processing in time of flight." Same for the following usage of workspaces that are referred to as TOF. Infact, please highlght the units for example IvsLam has x units of wavelength in Angstroms^-1

4) Options. How do I get to the options.

I don't know if you're familiar with user centred design. Hopefully they are now teaching this at universities. Give one of the other students your documentation, and without telling them how to get it working, or helping them at all, see how they get on. When they get stuck. It's an indication that the documentation could be better. You can do this in iterations, but you need fresh people each time round.

[Harry Jeffery]

Refs #10600 Add purpose section

Changeset: 940880d697a744a9df79fc6e7b6828def3cd8d13

[Harry Jeffery]

Refs #10600 Move example workflow to top of refl ui docs

Changeset: 671f217c249720a99fddfed80718eb1a3640957f

[Harry Jeffery]

Refs #10600 Further refine Refl UI documentation

Changeset: d04818307eb975e69422db6af965d50218960d5e

[Harry Jeffery]

Refs #10600 Improve menu bar documentation

Changeset: 4217e919b9e3e435994631df6945451c6ed1b08d

[Harry Jeffery]

Testing

• Compile documentation & review it
• Inspect changes

[Owen Arnold]

Merge remote-tracking branch 'origin/feature/10600_update_refl_ui_docs'

Full changeset: ​a5bd7908b7296b87ba3254fa46b5f3f86f1184db

[Stuart Campbell]

This ticket has been transferred to github issue ​11442