Skip to content

Commit aca5ff6

Browse files
Expand asking for help guidance
1 parent d1a6842 commit aca5ff6

2 files changed

Lines changed: 49 additions & 0 deletions

File tree

courses/zoomcamp-logistics/asking-questions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,26 @@ Try to narrow the problem first. You do not need to solve it alone. A few minute
3636

3737
It is normal for technical problems to take time. If you are stuck after trying the steps above, ask in Slack.
3838

39+
## If You Cannot Find the Problem
40+
41+
Sometimes the hard part is not fixing the problem. The hard part is figuring out where it starts. In that case, write down what you know:
42+
43+
- The last step that worked.
44+
- The first step that failed.
45+
- What you expected to happen.
46+
- What actually happened.
47+
- What changed since it last worked: code, data, dependency versions, environment variables, Docker image, notebook kernel, cloud resource, or operating system.
48+
49+
Then try to make the problem smaller:
50+
51+
1. Run the command again from a clean terminal and copy the full output.
52+
2. Remove unrelated code or steps until you have the smallest example that still fails.
53+
3. Check whether the problem happens in the course example code or only in your own code.
54+
4. Check whether the problem happens after restarting the service, container, notebook kernel, or machine.
55+
5. Compare your command, file path, environment variables, and versions with the lesson instructions.
56+
57+
If you still cannot identify the cause, say that in your question. "I do not know where the problem is yet, but this is the last step that worked and this is the first failing command" is a useful starting point.
58+
3959
## Asking in Slack
4060

4161
Start a new message in the course channel with a short problem summary. Then put details in a thread so the main channel stays readable.

general/guidelines/asking-for-help.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,41 @@ Examples of meta questions to avoid:
2626

2727
When something doesn't work and you need help figuring it out, we'll be happy to help.
2828

29+
Before posting, try to narrow the problem. You do not need to solve it alone, but helpers need enough information to understand where you are stuck.
30+
31+
Check:
32+
33+
- The exact error message.
34+
- The command, query, notebook cell, or action that produced it.
35+
- The last step that worked.
36+
- The first step that failed.
37+
- What you expected to happen.
38+
- What actually happened.
39+
- What changed recently: code, data, dependency versions, environment variables, Docker image, credentials, cloud resource, or operating system.
40+
41+
If you do not know where the problem is, say that clearly and share what you already checked. A useful question can start with: "I do not know which part is failing yet. The last step that worked was ..., and the first failing command is ..."
42+
2943
To get the best assistance quickly, follow these recommendations:
3044

3145
- Use threads for errors. First describe the problem briefly in the main channel, then put the actual error message and code in a thread.
3246
- Copy-paste text, don't screenshot. Don't take screenshots of your code or terminal output. Instead, copy-paste the error message and code as text. Use code blocks (three backticks) to format your code. Text is searchable, easier to read, and allows helpers to copy your code if needed.
3347
- Never photograph your screen. Don't take pictures of your code with a phone. It's even harder to read than screenshots. Always copy-paste text. In rare cases when you need to show what happens on your screen visually (like a UI issue), a screenshot is acceptable, but code and errors should always be text.
3448

49+
Include:
50+
51+
- What you are trying to do.
52+
- The relevant context: course, project, tool, dataset, operating system, or service.
53+
- The exact command or action you tried.
54+
- The full error message as text.
55+
- The smallest relevant code snippet or a link to the repository when the issue depends on your code.
56+
- What you already tried and what happened.
57+
58+
Use triple backticks for commands, code, and error output:
59+
60+
<pre><code>```
61+
paste the error here
62+
```</code></pre>
63+
3564
## Don't tag instructors
3665

3766
Don't tag the cohort lead or other instructors in your question. They have notifications enabled and will see questions in the course channel without being tagged. Tagging an instructor signals that the question is for them specifically. That makes other participants less likely to jump in, even though they are often the fastest source of an answer. Posting in the course channel without a tag is the right move.

0 commit comments

Comments
 (0)