<remedy>

The <remedy> element contains steps that are a potential solution for a problem. In addition, it also might contain information about the person or team who can perform the task.

Usage information

The <remedy> element is a component of a potential solution. The remedy might be omitted if there is no known remedy for the cause.

Specialization hierarchy

The <remedy> element is specialized from <section>. It is defined in the troubleshooting module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes.

Example

This section is non-normative.

In the following code sample, the <remedy> element contains instructions for how the responsible party can fix the problem:

<troubleshooting id="simple-example">
  <title>System will not turn on</title>
  <troublebody>
    <!-- . . . -->
    <troubleSolution>
      <!-- . . . -->
      <remedy>
        <title>Reset the circuit breaker</title>
        <responsibleParty>Maintenance technician</responsibleParty>
        <steps>
          <step><cmd>Power the system down.</cmd></step>
          <step><cmd>Reset the circuit breaker.</cmd></step>
          <step><cmd>Power the system back up.</cmd></step>
        </steps>
      </remedy>
    </troubleSolution>
  </troublebody>
</troubleshooting>