--- title: "Writing troubleshooting topics" id: "6953" type: "post" slug: "writing-troubleshooting-topics" published_at: "2014-06-16T12:29:15+00:00" modified_at: "2014-06-16T12:29:15+00:00" url: "https://www.cherryleaf.com/2014/06/writing-troubleshooting-topics/" markdown_url: "https://www.cherryleaf.com/2014/06/writing-troubleshooting-topics.md" excerpt: "It’s a fair bet that the introduction of the new Troubleshooting information type into the DITA 1.3 technical authoring standard will affect how all Technical Authors write troubleshooting topics, regardless of whether they use DITA or not. That’s because the..." taxonomy_category: - "DITA" - "standards" - "Technical Author" - "Technical Documentation" - "Technical Writing" taxonomy_post_tag: - "DITA" - "standards" - "Technical Authors" - "Technical Writing" - "troubleshooting" --- It’s a fair bet that the introduction of [the new Troubleshooting information type](https://www.oasis-open.org/committees/download.php/40204/troubleshootingdoc.pdf) into the DITA 1.3 technical authoring standard will affect how all Technical Authors write troubleshooting topics, regardless of whether they use DITA or not. That’s because the proposed elements for troubleshooting topics make good sense, and it offers a standardised approach to writing these types of topics. According to the Oasis DITA standards committee, > Troubleshooting topics provide descriptions of and solutions or workarounds for problem situations that users might encounter. Users refer to troubleshooting information to understand what condition or event generated their problem situation and to find out what they need to do to recover from or work around a problem, or to prevent a recurrence of the problem. The user would see a topic that looks roughly like this: --- # Application is not responding ## Overview This topic explains what to do if the application is not responding to your keyboard or mouse. ## The problem The application does not respond to input from the keyboard or the mouse. ## The cause The application has entered into a state from which it cannot recover. ## Remedy 1. Right-click on the Windows task bar and select **Task Manager**. 2. Right-click on the application and select **End Task**. The application should now respond correctly. If it does not, please contact the Support desk. ## Responsible party Users must fix this problem. ## Related topics See also: - Adding a widget --- You’ll notice there are a set of common headings: | Section | Description | Example | | --- | --- | --- | | Topic Title | A brief statement of the problem. | Application is not responding. | | Overview/Introduction | A fuller explanation of the purpose of the procedure and when you would use it. | This topic explains what to do if the application is not responding to your keyboard or mouse. | | Condition (the problem) | Usually the condition or symptom is an undesirable state in a system, a product, or a service that a reader may wish to correct. | The application does not respond to input from the keyboard or the mouse. | | Cause | A cause for the condition or symptom. | The application has entered into a state from which it cannot recover | | Remedy (Solution) | A remedy for the condition or symptom that restores the system, product, or service to its normal state.The step-by-step instructions that explain how to actually do the procedure.Steps begin with an action statement that tells the user what to do. Every action statement contains a “command” verb.A step may also contain a feedback statement. This tells the user what happens as a result of completing the step. | Right-click on the Windows task bar and select Task Manager. Right-click on the application and select End Task. | | Responsible Party | Who is expected to perform the steps in the remedy. | Users must fix this problem. | | See also | Links to related topics. | See also: Adding a widget | We think the proposed structure is good, and it’s worth adopting. What do you think? ### Share this: - [Share on Facebook (Opens in new window) Facebook](https://www.cherryleaf.com/2014/06/writing-troubleshooting-topics/?share=facebook) - [Share on LinkedIn (Opens in new window) LinkedIn](https://www.cherryleaf.com/2014/06/writing-troubleshooting-topics/?share=linkedin) - [Share on WhatsApp (Opens in new window) WhatsApp](https://www.cherryleaf.com/2014/06/writing-troubleshooting-topics/?share=jetpack-whatsapp) - [Share on Bluesky (Opens in new window) Bluesky](https://www.cherryleaf.com/2014/06/writing-troubleshooting-topics/?share=bluesky) - ### *Related* ### 4 Comments Re. Overview/Introduction IMHO too generic. May invite tech authors to write long stories or repeat the title. Proposed solution: “Short Description”. Dita authors are familiar with Short Desc and guidelines for writing _good, meaningful_ Short Descriptions are available (s. Kirsten Eberlein and Michelle Carey) You’re right that writers following DITA 1.3 standard will use ShortDesc instead of Overview or Introduction. For writers not using DITA, and for users, both of whom are unlikely to understand the phrase Short Description, Overview or Introduction is probably a more meaningful phrase to use. You have necessarily used a simple example with a single symptom and a single solution. I wonder how well it will work for a less well defined problem like “The system is slow to respond” or “Some of my messages don’t always get delivered”, where some real investigation is required to pin down exactly what has gone wrong and what course or courses of action are likely to alleviate the problem. I guess that will depend to some extent on how flexible the “Remedy” element is. From the example it looks as if it contains , so it probably also allows , but will it allow generic text in or tags? In the scenario you posed, it would probably be better to use the concept information type, perhaps linked to other to tasks or a list of potential troubleshooting remedies. ### Leave a Reply[Cancel reply](/2014/06/writing-troubleshooting-topics/#respond) This site uses Akismet to reduce spam. [Learn how your comment data is processed.](https://akismet.com/privacy/) #### Previous post [Why you probably shouldn’t use Word to create your policy documents](https://www.cherryleaf.com/2014/06/why-you-probably-shouldnt-use-word-to-create-your-policy-documents/) #### Next post [What would life be like if there were no instruction manuals you could read?](https://www.cherryleaf.com/2014/06/what-would-life-be-like-if-there-were-no-instruction-manuals-you-could-read/) #### Browse posts by month Browse posts by month Select Month October 2026 (3) September 2026 (12) August 2026 (8) July 2026 (7) June 2026 (14) May 2026 (8) April 2026 (6) March 2026 (14) February 2026 (9) January 2026 (9) December 2025 (7) November 2025 (9) October 2025 (10) September 2025 (7) August 2025 (6) July 2025 (1) June 2025 (3) May 2025 (2) April 2025 (5) March 2025 (3) February 2025 (3) January 2025 (2) November 2024 (8) October 2024 (3) September 2024 (2) August 2024 (3) July 2024 (4) June 2024 (1) May 2024 (2) April 2024 (4) March 2024 (1) February 2024 (2) January 2024 (1) December 2023 (2) November 2023 (9) October 2023 (8) September 2023 (5) August 2023 (3) July 2023 (1) June 2023 (1) May 2023 (2) April 2023 (3) March 2023 (2) January 2023 (2) December 2022 (4) November 2022 (1) October 2022 (1) September 2022 (1) August 2022 (1) July 2022 (1) June 2022 (1) May 2022 (2) April 2022 (1) March 2022 (1) February 2022 (1) January 2022 (2) December 2021 (1) November 2021 (2) October 2021 (1) August 2021 (1) July 2021 (2) June 2021 (3) May 2021 (5) April 2021 (3) March 2021 (3) February 2021 (1) January 2021 (2) December 2020 (4) November 2020 (4) August 2020 (3) February 2020 (3) January 2020 (1) November 2019 (3) October 2019 (1) September 2019 (1) August 2019 (3) July 2019 (2) June 2019 (3) May 2019 (4) April 2019 (1) November 2018 (2) October 2018 (1) July 2018 (2) June 2018 (4) May 2018 (2) April 2018 (3) March 2018 (4) February 2018 (2) January 2018 (3) December 2017 (2) October 2017 (3) September 2017 (1) August 2017 (3) July 2017 (2) June 2017 (7) May 2017 (4) April 2017 (5) March 2017 (1) February 2017 (7) January 2017 (1) December 2016 (3) November 2016 (4) October 2016 (1) September 2016 (5) July 2016 (1) June 2016 (3) May 2016 (1) April 2016 (2) February 2016 (2) January 2016 (5) December 2015 (1) November 2015 (4) October 2015 (2) August 2015 (1) July 2015 (1) June 2015 (2) May 2015 (3) February 2015 (2) January 2015 (6) December 2014 (1) October 2014 (1) September 2014 (4) June 2014 (4) May 2014 (1) April 2014 (2) March 2014 (3) February 2014 (4) January 2014 (4) November 2013 (2) October 2013 (5) September 2013 (3) July 2013 (3) June 2013 (11) May 2013 (4) April 2013 (6) March 2013 (7) February 2013 (4) January 2013 (4) December 2012 (9) November 2012 (23) October 2012 (14) September 2012 (8) August 2012 (4) July 2012 (12) June 2012 (12) May 2012 (10) April 2012 (8) March 2012 (12) February 2012 (3) January 2012 (6) December 2011 (2) October 2011 (3) August 2011 (1) June 2011 (5) May 2011 (2) April 2011 (1) January 2011 (1) December 2010 (1) November 2010 (3) October 2010 (4) September 2010 (8) August 2010 (5) May 2010 (2) April 2010 (3) March 2010 (3) February 2010 (2) January 2010 (3) December 2009 (2) November 2009 (6) September 2009 (1) July 2009 (6) June 2009 (7) April 2009 (8) March 2009 (3) February 2009 (3) January 2009 (3) December 2008 (1) November 2008 (3) October 2008 (3) September 2008 (4) August 2008 (1) July 2008 (3) June 2008 (5) May 2008 (2) April 2008 (2) March 2008 (3) February 2008 (2) January 2008 (1) November 2007 (3) October 2007 (2) September 2007 (1) July 2007 (3) November 2006 (1) October 2006 (2) September 2006 (3) August 2006 (1) April 2006 (1) March 2006 (3) #### Browse posts by category