Adobe FrameMaker User Guide
Click here to see this page in full context
Home > Appendix > DITA 1.3 specification > Language reference: All-inclusive edition > Technical content elements > Troubleshooting elements
Troubleshooting topics document corrective action such as troubleshooting or alarm clearing.
<troubleshooting> element is the top-level element for a troubleshooting topic. Troubleshooting topics begin with a description of a condition that the reader might want to correct, followed by one or more cause-remedy pairs. Each cause-remedy pair is a potential solution to the trouble described in the condition.<troublebody> element is a container for the main content of the troubleshooting topic. <condition> element describes a state that the troubleshooting topic is intended to remedy. This information helps the user decide whether a troubleshooting topic might contain an applicable remedy for a problem. This section should add to or clarify information that is in the tile or short description of the troubleshooting topic.<troubleSolution> element is a container element for cause and remedy information. The cause might be omitted if it is implicit or if the remedy is not associated with a cause. The remedy might be omitted if there is no known remedy for the cause.<cause> element describes a potential source of the problem that is described in the <condition> element, the topic <title> element, or the <shortdesc> element. This information should be brief; if it is not possible to make the information brief, this might be a sign that a full troubleshooting topic is needed<remedy> element contains steps that are a potential solution for the problem described in the <condition> element, the topic <title> element, or the <shortdesc> element. Typically, a <remedy> is preceded by a <cause>.<responsibleParty> element to identify the party who is responsible for performing a remedy procedure.