Documentation structure

At the moment we have a lot in our top-level navigation that ended up there by default and wasn't thought about whether that was the appropriate place to put it (eg Where do my results go? and the quickstart guides - which are also different types of documentation).

Are the guides useful in their current form?

Quickstart guide for experiences users is a reference, guide for new users is a how to.

How tos should be specific and self-contained and intended to be followed start to finish, should stand on their own. Reference to dip into as needed.

No longer have an FAQ - some of this is in the how tos page. Have a look at NASA FAQ.

Linked:
NASA HECC: https://www.nas.nasa.gov/hecc/support/kb/
TACC: https://docs.tacc.utexas.edu/

Supplementary directory needs to be checked, some old stuff just left in there. (Troubleshooting page should probably be in FAQs?)

Other Software is not easily found and not linked from Example Jobscripts.
Example script in repo that be generated into docs for each piece of software. (We already have one of those, currently used by OOD stuff). get_example application to get the example jobscript that you can run.
Info on requesting access to applications isn't mentioned with the docs for those applications.

Improve interactive jobs page (mention cluster-specific info exists?)

Identify if some of our "general" pages are really only about Myriad and have significant differences for Kathleen/Young etc.

• Outline of what structure we have now, and some design principles so we know where new things should be added when they come up.

Start by outlining the current top-level navigation and checking the supplementary directory, Example Jobscripts, and the interactive jobs page. Compare the guide, FAQ, how-to, and reference distinctions with the linked NASA HECC and TACC documentation. Done means the current structure and design principles are documented, with proposed placement and missing links or access information identified.