Troubleshooting Template¶
Note
This is a procedure template file that is associated with a template directory structure. This note should be deleted when the section is properly populated.
Overview¶
This is a template for a troubleshooting procedure. It is performed by authorized and trained users.
Error diagnosis¶
This is an example bullet.
Procedure Steps¶
This paragraph describes some general guidance for this procedure. This paragraph is optional depending on its usefulness and the complexity of the procedure.
In the case of a very straightforward procedure, a simple numbered list could be used, like as follows:
Warning
For this example, this step is critical.
This is Step 1 in a enumerated list. It happens to be very important.
This is Step 2.
This is step 3.
Step 4 has two branches, but Step 5 is independent of Step 4.
If Condition A, do the following action in Condition A Instructions.
If Condition B, do the following action in Condition B instructions.
Complete the procedure’s final step.
Condition A for Step 4¶
This is an example of a sub-section, used when Condition A applied. Complete the steps in this section:
Step 1 for Condition A.
Return to Step 5 in the section above.
Condition B for Step 4¶
This is an example of a sub-section, used when Condition B applied. Complete the steps in this section:
Step 1 for Condition B.
Return to Step 5 in the section above.
Post-Condition¶
This is an example bullet of a post-condition (Telescope azimuth is 0 degrees.)
This is another example of a post-condition (This procedure leaves the telescope with the E-stop activated.)
Contingency¶
If the procedure was not successful, report the issue in [relevant Slack channel] and/or activate the Out of hours support.