Tutorial Template#

Note

This is a tutorial template file that is associated with a template directory structure. This note should be deleted when the section is properly populated.

Important

This template is under heavy development and only in the very early stages of design. It should not be used nor consulted for a place of information at this time.

Overview#

This is a template for a tutorial.

Precondition#

This section should list the Precondition (e.g. required conditions) to perform the tutorial. If multiple sentences/conditions are required this should be presented in bullet form.

  • This is an example bullet (e.g. should have accounts on system XYZ)

    • This is a sub-bullet (e.g. can test by logging into VPN XYZ)

Post-Condition#

This section describes the state of the system after performing the tutorial. If multiple sentences/conditions are required this should be presented in bullet form.

  • This tutorial leaves the telescope in tracking mode.

    • Add Extra-guidance when required/useful. (e.g. can stop tracking using the following command)

Tutorial Steps#

This paragraph describes for the format of the Tutorial. This is optional as the usefulness depends upon the complexity of the procedure.

In the case of a very straightforward tutorial, a simple numbered list could be used, like as follows:

  1. This is Step in a numbered list

  2. This is step two.

Separate into Subsections#

In the case of more complicated tutorials, more sophisticated methodologies may be appropriate, such as using multiple section headings, then numbered lists under each heading.

Troubleshooting#