Skip to content

Commit f5374e6

Browse files
authored
Doc: how to ask for help
I do like pancakes.
1 parent fa18b8f commit f5374e6

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Help!
2+
3+
Things break. Sometimes they never worked. Maybe it needed a special incantation to work that nobody told you. And now something doesn't work and your work is blocked, so you decide to ask for the help.
4+
5+
## A common example
6+
Let's look at a made-up example between person A and C who need help with making a pancake and person B who used to be a chef:
7+
8+
**A:**
9+
> Hi! I was trying to make a pancake for breakfast, I got the mix, but it doesn't cook! Can you help?
10+
11+
**B:**
12+
> What kind of pancake, American, Swedish?
13+
>
14+
> How did you make the mix?
15+
>
16+
> How much of the mix did you put in the pan?
17+
>
18+
> Did you use a pan or a pot?
19+
>
20+
> Is the stove on?
21+
>
22+
> What kind of stove is it? Electric? Induction? Fire?
23+
>
24+
> Is your pan (if you used one) compatible with that kind of stove?
25+
>
26+
> Did you make the mix yourself or did you buy it?
27+
>
28+
> Is the stove plugged in?
29+
>
30+
> Did you turn on the right stove? You could burn yourself if you turned on the wrong one...
31+
>
32+
> You said it doesn't cook, but how does it look? Maybe it IS cooked, but you just don't know what a cooked pancake looks like?
33+
34+
(and so on)
35+
36+
Notice how many questions person B could come up with that WOULD explain the issue A is having. This tires B, takes 10 times longer than it should, and probably makes B annoyed since this is likely the 10th time they had to do this whole dance today.
37+
38+
### How it could have been
39+
40+
**C:**
41+
> Hi! I was trying to make a **Swedish** pancake for breakfast, I **made** the mix **following this recipe**, but it **doesn't seem to change color**! **I put X amount of mix on a flat iron pan and turned on the stove and waited for Y minutes** Can you help?
42+
>
43+
> **<Attached picture of the mix, in the pan, on the stove>**
44+
45+
**B:**
46+
> Ah, I see, your stove is not on, I could see from the pic that the lights on the front of the stove are all off despite the (correct) dial you turned. You probably didn't press the safety timer on the wall behind the stove.
47+
48+
49+
See how B could identify the issue right away, and it was something that A could not have known could even BE an issue in the first place. And this took 1/10th the time to reach a solution.
50+
51+
Notice how C included the entire _story_ they lived, so that B didn't have to ask 100 questions to explore that same story.
52+
53+
#### But we don't make pancakes, we make robots?
54+
55+
Then your pancake mix is a script, your recipe a tutorial, your expected change in color is a ros topic, your stove is the sim, the button you didn't know about is a script that needed to be running, your stove picture is your terminal output.
56+
57+
## If you have been sent this document
58+
do not feel bad. Learning to ask for help effectively is not part of anybody's education. The sender is not mad, they are probably just tired of explaining this, so they hope this document would do that for them, and most likely expect you to come back with a request more like person C :)

0 commit comments

Comments
 (0)