Troubleshooting, alarm, event, and error topics describe a system issue and provide a recommended solution. Two templates are available in Tridion Docs for these types of topics: Troubleshooting or Alarm event error. These templates are based on the troubleshooting topic model in DITA.
These topics include the following:
Description or information about a problem, alarm, event, or error
One or more possible causes
One or more associated resolution or remedy
The troubleshooting topic model is flexible. You can have one or more cause and one or more remedies. The following table describes some possible combinations of cause and remedy.
Scenario
Elements to use in topic
A condition with one cause and one remedy.
Use one troubleSolution element with one cause and one remedy.
A condition with one cause and multiple possible remedies.
Use one troubleSolution element with one cause and multiple remedy elements.
A condition with multiple causes, each with one or more possible remedies.
Use a separate troubleSolution element for each cause and its associated remedies. If a cause has multiple possible remedies, use a remedy element for each remedy.
