From dca4cf07901309f88bb5fd0cc11d72eba907f6bb Mon Sep 17 00:00:00 2001 From: noahtalerman <47070608+noahtalerman@users.noreply.github.com> Date: Tue, 15 Jun 2021 14:51:45 -0400 Subject: [PATCH] Add tips for asking follow up questions in support process documentation (#1091) - Update /handbook/support-process.md - Add github.com/issues to ignored links in markdown link check --- .../workflows/markdown-link-check-config.json | 3 +++ handbook/support-process.md | 23 ++++++++++++++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/.github/workflows/markdown-link-check-config.json b/.github/workflows/markdown-link-check-config.json index 94d4c81e7..79ac5c010 100644 --- a/.github/workflows/markdown-link-check-config.json +++ b/.github/workflows/markdown-link-check-config.json @@ -23,6 +23,9 @@ }, { "pattern": "osquery.io/schema" + }, + { + "pattern": "github.com/issues" } ], "retryOn429": true, diff --git a/handbook/support-process.md b/handbook/support-process.md index 6a80dd199..1a7d3197c 100644 --- a/handbook/support-process.md +++ b/handbook/support-process.md @@ -24,10 +24,31 @@ The Roundup meeting at Fleet provides time to discuss action items from that are - The individual on-call is responsible to either schedule a 10 minute call or join the 🧩 Product meeting to ask questions they were unable to answer. If a response is needed quicker, you can always DM Fleet team members in Slack. This way, people get answers within 1 business day. -- If you do not understand the question or comment raised, request more details to best understand the next steps. +- If you do not understand the question or comment raised, [request more details](#requesting-more-details) to best understand the next steps. - If an appropriate response is outside your scope, please post to #oncall-chatter, an internal slack channel designed to filter community support questions to the Fleet team. +#### Requesting more details + +Typically, the *questions*, *bug reports*, and *feature requests* raised by members of the community will be missing helpful context, recreation steps, or motivations respectively. + +❓ For questions that you don't immediately know the answer to, it's helpful to ask follow up questions to receive additional context. + +- Let's say a community member asks the question "How do I do X in Fleet?" A follow question could be "what are you attempting to accomplish by doing X?" +- This way, you now has additional details when the primary question is brought to the Roundup meeting. In addition, the community member receives a response and feels heard. + +🦟 For bug reports, it's helpful to ask for recreation steps so you're later able to verify the bug exists. + +- Let's say a community member submits a bug report. An example follow up question could be "Can you please walk me through how you encountered this issue so that I can attempt to recreate it?" +- This way, you now have steps the verify whether the bug exists in Fleet or if the issue is specific to the community member's environment. If the latter, you now have additional information for further investigation and question asking. + +💡 For feature requests, it's helpful to ask follow up questions in an attempt to understand the "why?" or underlying motivation behind the request. + +- Let's say a community member submits the feature request "I want the ability to do X in Fleet." A follow up question could be "If you were able to do X in Fleet, what's the next action you would take?" or "Why do you want to do X in Fleet?." +- Both of these questions provide helpful context on the underlying motivation behind the feature request when it is brought to the Roundup meeting. In addition, the community member receives a response and feels heard. + + + ## Sources There are three sources that the individual on-call should monitor for activity: