“Is this the problem this fix is for?”
Show when the fix applies.
Describe the visible symptom, the affected screen, and the conditions that need to be true before someone follows the guide.
Troubleshooting guide software
Create troubleshooting guides so people can fix known problems without guessing.
Use UIHike to capture the symptom, the checks to make, the fix to try, and the result to expect—so the next person has useful context before they ask for help.
Start locally without an account. Cloud sharing requires an account.
The evidence belongs with the instructions
Show the path, not just the answer.
A short message saying “reset the filter” leaves room for doubt. A visual guide can show the starting screen, the setting to change, and the result the reader should see afterwards.
Build a guide someone can use
Answer the questions that stop a known fix from being useful.
Each part of the guide removes a different kind of uncertainty: whether this is the same problem, what to try, and whether it worked.
“What should I check and change?”
Capture the checks and fix in order.
Keep the relevant screens, settings, and notes together. Call out the decision that changes what the reader should do next.
“Did that actually solve it?”
Show the expected result and escalation point.
Include the screen or outcome that confirms success. If it looks different, say when to stop and pass on the context you have gathered.
An illustrative known-fix example
Help someone check why a report has no records.
In this example, a report looks empty because the selected date range has no matching records. The guide shows how to check the range, try the normal month, and confirm that the expected records return.
What the reader receives
- Starting conditionThe report shows an empty state.
- Known checkInspect the selected date range.
- Known fixChoose the previous calendar month.
- VerificationConfirm matching records appear.
- Escalation pointStop if expected records still do not appear.
Illustrative context based on the real UIHike guide below. It is not a production incident or a guarantee that every empty report has the same cause.
Use the guide at the right time
Document a proven fix. Investigate a new problem.
UIHike helps you preserve the screens and explanation behind a solution you already trust. When the symptom, cause, or outcome is unknown, use your normal investigation and escalation process first.
See capture, editing, and sharing in UIHike ↗
Questions about troubleshooting guides
When should I create a troubleshooting guide?
Create one after you have identified a reliable resolution for a problem that people encounter again. Describe the symptom, the conditions where the fix applies, the steps to take, and the result to expect. For a new or unexplained problem, investigate it through your existing process first.
Is UIHike a diagnostic or ticketing system?
No. UIHike helps you create visual documentation. It does not diagnose a device or application, route support tickets, decide the cause of a problem, or automatically apply a fix.
How can I show that a fix worked?
Capture the expected screen or outcome, and add a note explaining what the reader should check. If the result differs, say when they should stop and use their existing escalation process.
Can the guide include browser and desktop applications?
Yes. The Windows app can combine browser captures with window or region screenshots from other applications. Supported browser recording can retain URLs and interaction context; desktop screenshots do not carry the same browser metadata.
Can someone read the guide without UIHike?
Public and unlisted published guides can be read in a browser without a UIHike account. Private guides require the appropriate access. You can also use supported exports such as HTML and Markdown. Cloud sharing requires an author account.
Start with the fix people keep asking you to explain.
Capture the situation, the steps, and the result while the solution is still fresh. Give the next person a guide to follow.
Download for Windows
Local Windows use without an account.
Cloud sharing requires an account.