TroubleshootingLast updated: 07/02/2023
A troubleshooting guide helps the user with a specific problem or issue with the software, to solve or perform a workaround. This includes a description the problem, the cause including typical use case to repeat the problem, a description of the solution including step-by-step instructions and lastly references to related documentation in a knowledge base, user, product or operating manual.
6.1 Troubleshooting Example
Describe the problem and the result including any error messages or codes. Include the primary use case(s) where the problem occurs and lastly where possible describe the cause of the problem. Provide a summary table error codes and messages
Solution
provide a detailed solution of the problem(s) Including scenarios applicable to different systems. Use a step-by-step approach preferably with a numbered list including the outcome of each step. If a step-by-step solution is not available describe potential workarounds that may be applicable together with any reference information.
Related issues
Where the problem is dependent upon other issues for example user permissions created by an update to the host operating system provide references to the workarounds to the related problems in order to solve the users issue.