User Manual: Enhance the "Manage the DAE" section

[kjwoodsISIS]

As a support person, I would like to enhance the Manage the DAE section of the User Manual, so that visiting scientists can use it to guide their use of the DAE.

Acceptance Criteria

1. Expand the Manage the DAE section, notably the following sub-sections:
   1. Experiment Setup and descriptions of the Time Channels, Data Acquisition & Periods tabs
   2. Spectra Plots (e.g. a description of what exactly the spectra plots show).

      Notes

2. The User Manual can be edited from:
   1. https://github.com/ISISComputingGroup/ibex_user_manual/wiki or
   2. http://shadow.nd.rl.ac.uk/ibex_user_manual/Home
3. Adapt material from Freddie's DAE presentation.

[John-Holt-Tessella]

Maybe do this as part of #1581 the support workshop with Freddie leading this section. Then we can write it up later.

[John-Holt-Tessella]

Added mentioned documentation to sharepoint. They are ISISICP and DAE.pptx and SECI User Manual.doc

[John-Holt-Tessella]

Started this and have taken some information out of the documents. Add something on monitors. Have added some DAE troubleshooting to the FAQ (read this too). But I have now reached the end of my knowledge

[John-Holt-Tessella]

Chatted with Matt to finish

[John-Holt-Tessella]

See https://github.com/ISISComputingGroup/ibex_user_manual/wiki/ManagetheDAE

[AdrianPotter]

• [x] Please link back to the managing the DAE section from: https://github.com/ISISComputingGroup/ibex_user_manual/wiki/KeyConceptsinIBEX#dae-data-acquisition-electronics
• [x] Replace The view is split into a number of tabs and sub tabs. with `The DAE can be managed from the DAE view in the client. It is split into a number of tabs and sub tabs. I know that sounds picky, but the page only implicitly relates to the DAE perspective. The manual should make that relation explicit.
• [x] Under Run summary fields, have either the colon or records, not both. Otherwise it doesn't make grammatical sense. Further, the records just add repetitive bulk. I'd drop them.
• [x] The run control buttons seem to have the wrong heading. They currently appear under Message Log. I'd suggest creating a sub-heading for Run control buttons.
• [x] The comments on the IBEX dashboard apply to all run control buttons. Move them out of the Begin run button section and into the newly created parent section Run control buttons.
• [x] The Save Run sub header is the only one in the format Click on this to..., rather than This will... or equivalent. It would be better to keep a consistent style.
• [x] Under Experiment setup, consistently use three and 3. In fact, the 3s can be dropped entirely without any loss of meaning.
• [x] Same with tabs and sub-tabs: be consistent. Use one or the other, but don't change, or it may be confusing.
• [x] Clicking the run summary link under the Experiment setup header doesn't do anything
• [x] The Time Channels section seems a little incomplete. It doesn't give much description of the various headers and options available within the time regime tables. Are we assuming instrument scientists just know all of that?
• [x] Can you add a hyperlink on settings in the Time Channels section on how to set up instrument settings for the instrument (notably where the files are).
• [x] Under Data Acquisition I don't think the colons are necessary at the end of the sub-headers
• [x] As previously, link back to information about instrument settings in the Data Acquisition/Tables subsection
• [x] In Periods, the first setup should be set up. The former is a noun, the latter is a verb
• [x] In Periods, hardware should not have a capital letter.
• [x] Under Spectra Plots, the first Tab should not be capitalised.
• [x] As previously, the first setup should be set up.
• [x] I don't think the fields should have colons, either in the manual or the GUI
• [x] Diagnostics: You've left the manual blank, or the GUI is blank? Be clear. Is extra effort needed on this ticket before completion?
• [x] I agree that the correct plural of 'veto' is 'vetoes', but I don't think you can refer to the 'vetoes' tab as there isn't one.

[kjwoodsISIS]

Some comments on the above suggestions:

The Time Channels section seems a little incomplete. It doesn't give much description of the various headers and options available within the time regime tables. Are we assuming instrument scientists just know all of that?

There is very little "official" documentation on how the DAE works - the documentation of the corresponding features of SECI is equally meagre. So, yes, we are in fact assuming that scientists just know all of that stuff.

Diagnostics: You've left the manual blank, or the GUI is blank? Be clear. Is extra effort needed on this ticket before completion?

The GUI is intentionally left blank.

[AdrianPotter]

Super. Thanks for addressing all points, especially given some were very picky :smile: