How to Ask Effective Questions
September 5, 2024
In both work and daily life, we often need to ask others for help.
This article focuses on the process of using various software systems (such as: Guance, DataFlux Func), and when encountering issues, how to ask effective questions in order to reduce workload for all parties involved and improve efficiency.
Note: The following content mentions the limitations of screenshots to some extent, but it does not mean 'do not take screenshots,' rather 'do not only take screenshots'!
1. Complete Cause-and-Effect and Related Operations
Providing a complete account of events leading up to the issue, along with the results of related operations, allows others to pinpoint problems faster and avoid repeated questioning.
Correct Example: Provides reproducible operational steps, and related operations help eliminate some possibilities, narrowing down the investigation scope.
| Information Point | Description |
|---|---|
| Operation before the issue | I previously upgraded DataFlux Func from version 1.0 to 2.0 |
| Operation causing the issue | I attempted to log in to DataFlux Func using the 'Guance backend administrator' method |
| Actual observed phenomenon | Entered the username and password, but the page displayed an incorrect username or password error |
| Expected result | This username and password should be able to log in |
| Result of related operations | I can log in normally using 'system built-in users' |
Incorrect Example: It's almost impossible to obtain any useful information from the description, which will inevitably require repeated questioning to gather more details.
| Information Point | Description |
|---|---|
| ? | Unable to log in to DataFlux Func |
2. Complete Request and Response
Many people know that in Chrome / Edge, you can use F12 to bring up the console and view erroneous requests. However, many people simply take screenshots of the console without providing further useful information.
Therefore, for situations where errors can already be found in the console, more detailed information can be provided through the following methods:
2.1 Console Information
To save console logs, simply right-click in the console and select "Save as...", which will save the entire console log (including expanded content) as a text file.
The downloaded log text file can facilitate copying of its contents during subsequent investigations, avoiding omissions of key information due to screen size issues when taking screenshots.
2.2 Request / Response Information
If an erroneous request is discovered, the complete request/response information should be provided, not just a screenshot of red text
3. Monitor / Message Desk Function Logs
In the latest versions, monitors in Guance and the alert messages they send are implemented based on functions within the bundled DataFlux Func.
If there are questions about the execution process of these tasks, corresponding task execution logs can be queried.
For specific query methods and partial interpretations, refer to Series: Guance Monitors
4. DataFlux Func Overview and About
The overview page and about page of DataFlux Func provide a large amount of information about the system itself.
For cases such as scheduled tasks not executing or executing slowly, the 'Overview' page can be checked to confirm whether the service is running normally, if queue pressure is too high, or if the total number of triggered scheduled tasks is excessive.
If you need to obtain DataFlux Func version, database information, Redis information, etc., you can query the corresponding information in the 'About' section.
5. When Only Screenshots Are Possible
In some extreme cases, such as when customer environments do not allow direct operations, resulting in the inability to download, copy any text or files, only screenshots, or even photos of the screen are possible.
Facing such situations, you must feel very inconvenient and uncomfortable!
But remember, the person responsible for answering your question feels even more inconvenienced and uncomfortable!!
Don't overthink it; if you need to take screenshots, take them, if you need to take photos, take them, don't miss a single one.
X. Summary
Improving the effectiveness and efficiency of asking questions can help others quickly identify and solve problems, which inherently increases the efficiency and accuracy of obtaining answers.
At any time, avoid the so-called "starting with a single image, leaving everything else to guess" type of perfunctory questioning.
What? You say you're busy and don't have time? That's funny! Do you think I'm idle?!