[DRIVERS-2023] Add section to troubleshooting FAQ per driver with top SEO results Created: 10/Jan/22 Updated: 03/May/22 |
|
| Status: | Implementing |
| Project: | Drivers |
| Component/s: | Docs |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Unknown |
| Reporter: | Jeffrey Yemin | Assignee: | Rachelle Palmer |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||||||||||||||||||||||
| Driver Changes: | Needed | ||||||||||||||||||||||||||||||||||||||||||||
| Quarter: | FY23Q2 | ||||||||||||||||||||||||||||||||||||||||||||
| Downstream Changes Summary: | Teams should review the links Rachelle included on each language team ticket and and add documentation pages for these common errors. |
||||||||||||||||||||||||||||||||||||||||||||
| Engineering Lead: | |
||||||||||||||||||||||||||||||||||||||||||||
| Product Manager: | |
||||||||||||||||||||||||||||||||||||||||||||
| Driver Compliance: |
|
||||||||||||||||||||||||||||||||||||||||||||
| Description |
SummaryUsers often get a stack trace/error message indicating a connectivity issue and then paste the text into Google looking for a solution. Each month, various driver and language project tickets get thousands, or tens of thousands, of views via these searches, and users are forced into:
We should add documentation pages for the most common errors to our official documentation so that these searches are fruitful. MotivationWho is the affected end user?Application or operations engineers. How does this affect the end user?The hypothesis is that they are frustrated to not find the information they need. They end up finding random Jira issues that don't have useful information, or that the information they find is outdated, or difficult to understand rather than a straightforward Q&A. How likely is it that this problem or use case will occur?It's an edge case, but not uncommon. Google SEO is showing that our most "popular" Jira issues are for issues like this, e.g. If the problem does occur, what are the consequences and how severe are they?Minor/major annoyance at a log message, misconfiguration, outdated knowledge of how drivers work, extra work/cognitive burden Is this issue urgent?No but it would be useful to our SEO to correct this problem Is this ticket required by a downstream team?No Is this ticket only for tests?No |