`<diagnostics-steps>`

The <diagnostics-steps> element includes step-by-step information that can help readers determine the causes of a symptom. Results of the diagnostic steps might link to potential solutions.

Usage information

This element is helpful for situations where the reader must perform a series of steps to determine the cause of the problem.

Specialization hierarchy

The <diagnostics-steps> element is specialized from <section>. It is defined in the troubleshooting module.

Attributes

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

Example

This section is non-normative.

The following code sample shows how the <diagnostics-steps> element can provide step-by-step instructions to help someone determine the cause of a problem and the potential solution:

<troubleshooting id="my-network-isnt-working">
  <title>My network isn't working</title>
  <shortdesc>Users are unable to access network servers, the internet, or other 
      networked devices, such as printers.</shortdesc>
  <troublebody>
    <diagnostics>
      <diagnostics-steps>
        <steps>
          <step>
            <cmd>Open the command prompt and type <userinput>ipconfig</userinput>.</cmd>
            <info>The Default Gateway (listed last) is your router’s IP. Your computer’s IP
                address is the number next to “IP Address.” If your computer’s IP address
                starts with 169, the computer is not receiving a valid IP address. See
                <xref href="#./ipaddress"/>.
            </info>
          </step>
          <step>
            <cmd>If your address does not start with 169, type 
               <userinput>tracert8.8.8.8</userinput> to view each step between your router 
               and the Google DNS servers.</cmd>
            <info>If the error comes up early along the pathway, see 
                <xref href="#./resetnetwork"/></info>
          </step>
          <step>
            <cmd>If everything is working with Google, use the <cmdname>nslookup</cmdname> 
               command to determine if there's a problem with the server you are trying 
               to connect to.</cmd>
            <info>If you received results such as <msgph>Timed Out</msgph>, 
                <msgph>Server Failure</msgph>, <msgph>Refused</msgph>, 
                <msgph>No Response from Server</msgph>, or 
                <msgph>Network is unreachable<msgph>, the problem originates in the DNS 
                server for your destination.</info>
          </step>
          <step>
            <cmd>If the previous steps turn up no problems, contact your ISP to see if 
              they're having issues.</cmd>
          </step>
        </steps>
      </diagnostics-steps>   
    </diagnostics>
    <!-- The rest of this topic contains two <troublesolution> elements, each of which 
         contains a remedy. One remedy provides instructions for "Resetting your IP address" 
         and the other provides instructions for "Resetting your local network". The 
         cross references in the above steps resolve to the <remedy> elements. -->
  </troublebody>
</troubleshooting>