Skip to content

Commit 64850e5

Browse files
authored
Add a guide on how to ask a good question
1 parent dbc3722 commit 64850e5

1 file changed

Lines changed: 107 additions & 23 deletions

File tree

README.md

Lines changed: 107 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,132 @@
1+
# Node.js Help
2+
13
<p align="center">
24
<a href="https://nodejs.org/">
3-
<picture>
4-
<source media="(prefers-color-scheme: dark)" srcset="https://nodejs.org/static/logos/nodejsStackedLight.svg">
5-
<img src="https://nodejs.org/static/logos/nodejsStackedDark.svg" width="200px">
6-
</picture>
5+
<img src="https://nodejs.org/static/logos/nodejsStackedDark.svg" width="200px">
76
</a>
8-
<h1 align="center">Help</h1>
97
</p>
108

11-
Need help with Node.js? You've come to the right place!
9+
## Welcome to Node.js Help!
10+
11+
Whether you're a beginner or an experienced developer, Node.js Help is here to assist you with all your Node.js questions and concerns.
1212

1313
## Install
1414

15-
Check out [this wiki](https://github.com/nodejs/help/wiki/Installation)
16-
to learn how to install Node.js via binary archive on Linux and AIX.
15+
To install Node.js, check out [this wiki](https://github.com/nodejs/help/wiki/Installation) to learn how to install Node.js via binary archive on Linux and AIX.
1716

18-
## Participate
17+
## How to Ask a Good Question
1918

20-
You can participate by asking or answering open questions present
21-
in the [issues section](https://github.com/nodejs/help/issues).
19+
### 1. **Be Specific**
20+
- **Provide Context:** Explain the background or context of your question. This helps others understand your problem or inquiry better.
21+
- **Avoid Ambiguity:** Clearly state what you're asking about. Vague questions can lead to misunderstandings or irrelevant responses.
2222

23-
#### Note
23+
### 2. **Use Clear Language**
24+
- **Avoid Jargon:** If your question involves technical terms, ensure they are explained or defined.
25+
- **Be Concise:** Keep your question brief and to the point. Long-winded questions can be confusing and may lose the reader's interest.
26+
27+
### 3. **State Your Goal**
28+
- **Clarify Your Objective:** Explain why you're asking the question and what you hope to achieve by getting an answer.
29+
- **Express Your Expectations:** Let others know what kind of answer you're looking for.
30+
31+
### 4. **Provide Relevant Details**
32+
- **Include Relevant Information:** Give details that are pertinent to your question. This could include error messages, steps you've already taken, or relevant background information.
33+
- **Exclude Irrelevant Details:** Avoid cluttering your question with unnecessary information that may distract from the main issue.
34+
35+
### 5. **Be Respectful**
36+
- **Be Polite:** Remember to use polite language and tone, even if you're frustrated or facing challenges.
37+
- **Appreciate Responses:** When someone takes the time to answer your question, thank them for their help, even if the answer doesn't fully solve your problem.
38+
39+
### 6. **Check for Duplicates**
40+
- **Search Before Asking:** Before posting your question, search to see if it has already been asked and answered. Duplicate questions can clutter forums and waste people's time.
41+
42+
### 7. **Format Appropriately**
43+
- **Use Proper Formatting:** If you're asking your question on a platform that supports formatting (like a forum or Q&A site), use formatting to make your question more readable. Use headers, lists, and code blocks as needed.
44+
45+
### 8. **Proofread Your Question**
46+
- **Check for Errors:** Proofread your question before posting to ensure clarity and correctness. Typos or grammar mistakes can make your question harder to understand.
47+
48+
### 9. **Be Open to Feedback**
49+
- **Accept Criticism:** If someone suggests improvements to your question, consider their feedback constructively. It can help you ask better questions in the future.
50+
51+
### 10. **Follow Up**
52+
- **Engage with Responses:** Once you receive answers, engage with them. Ask for clarification if needed, and provide feedback on whether the answers were helpful.
53+
54+
## What to Ask:
55+
56+
### 1. Clear and Specific Questions:
57+
- How can I achieve [specific task] in my Node.js application?
58+
- What is the best way to handle [specific problem] in Node.js?
59+
- Can someone help me understand how [specific feature] in Node.js works?
60+
61+
### 2. Troubleshooting Questions:
62+
- I'm encountering [specific error] when trying to [specific action]. How can I resolve this?
63+
- What could be causing [specific behavior] in my Node.js code?
2464

25-
When inserting your code use 3 backticks, followed by `js` as shown below:
65+
### 3. Code Review and Optimization:
66+
- Can someone review my Node.js code and provide feedback on how to optimize it?
67+
- What are some best practices for improving the performance of my Node.js application?
2668

27-
![node-js](assets/backtick.png)
69+
### 4. Conceptual Questions:
70+
- Can someone explain the difference between [concept A] and [concept B] in Node.js?
71+
- How does [specific module or feature] in Node.js work under the hood?
2872

73+
### 5. Seeking Recommendations:
74+
- What is the recommended package for handling [specific task] in Node.js?
75+
- Can anyone suggest a good tutorial or resource for learning about [specific topic] in Node.js?
76+
77+
## What NOT to Ask:
78+
79+
### 1. General Programming Questions:
80+
- How do I write a for loop in JavaScript?
81+
- What is HTML and how does it work?
82+
83+
### 2. Personal Debugging:
84+
- Can someone debug my entire Node.js project for me?
85+
- Why isn't my code working? (without providing any specific details or code snippets)
86+
87+
### 3. Unsupported or External Package Issues:
88+
- I'm having trouble with a third-party package (not related to Node.js core). Can someone help?
89+
- Why doesn't this external package work in my Node.js project?
90+
91+
### 4. Opinion-Based Questions:
92+
- What is the best Node.js framework?
93+
- Which is better, callback functions or Promises?
94+
95+
### 5. Duplicate Questions:
96+
- I didn't find an answer to my question, but it's similar to this other question. Can someone help me anyway?
97+
- Why hasn't anyone answered my question yet? (without considering it might be a duplicate)
98+
99+
### 6. Requests for Complete Solutions:
100+
- Can someone write the entire code for my project?
101+
- I need help with my homework. Can someone do it for me?
102+
103+
### 7. Unrelated or Off-Topic Questions:
104+
- What's the weather like in New York today?
105+
- Can someone help me with my personal relationship issues?
106+
107+
### 8. Extremely Broad Questions:
108+
- How do I become a Node.js expert?
109+
- What can I do with Node.js?
110+
111+
#### Note
112+
113+
When inserting your code, use 3 backticks, followed by `js` as shown below:
29114
````
30115
```js
31116
console.log('happy coding!');
32117
```
33118
````
34-
35-
It gets rendered as such:
36119
```js
37120
console.log('happy coding!');
38121
```
39122

40-
## Chat
123+
## Participate
124+
125+
You can participate by asking or answering open questions present in the [issues section](https://github.com/nodejs/help/issues).
41126

42-
If you would prefer to get help via live chat rather than the issue tracker
43-
in this repository, you can try:
127+
## External Links
44128

45-
* [#nodejs](https://openjs-foundation.slack.com/archives/CK9Q4MB53) channel on the OpenJS Foundation Slack ([join here](https://slack-invite.openjsf.org/))
46-
* [#node.js channel on libera.chat](https://web.libera.chat?channels=node.js&uio=d4)
47-
* [Node.js Slack Community](https://node-js.slack.com/)
48-
* To register: [nodeslackers.com](https://www.nodeslackers.com/)
129+
- [Node.js Official Website](https://nodejs.org/)
130+
- [Node.js Documentation](https://nodejs.org/docs/latest/api/)
131+
- [Node.js GitHub Repository](https://github.com/nodejs/node)
132+
- [Node.js Slack](https://node-js.slack.com/) *([Get Invited](https://www.nodeslackers.com/))*

0 commit comments

Comments
 (0)