explaingit

ryanhanwu/how-to-ask-questions-the-smart-way

35,084JavaScriptAudience · developerComplexity · 1/5StaleLicenseSetup · easy

TLDR

A translated guide teaching people how to ask technical questions effectively in online communities, so they get better answers from experienced volunteers.

Mindmap

mindmap
  root((repo))
    What it does
      Teaches question-asking
      Guides research first
      Explains clarity tips
    Problem solved
      Vague questions ignored
      Frustrated volunteers
      No useful replies
    How to use
      Read in browser
      Share with team
      Reference anytime
    Audience
      New developers
      Students learning
      Team leads
    Key topics
      Pick right forum
      Write clear subject
      Describe symptoms
      Avoid bad behaviors

Things people build with this

USE CASE 1

Share with junior developers or students to help them ask better questions on Stack Overflow and GitHub.

USE CASE 2

Reference before posting to a technical forum or mailing list to improve your chances of getting a helpful answer.

USE CASE 3

Use as a team resource to reduce low-quality support requests and improve communication in your community.

Tech stack

Markdown

Getting it running

Difficulty · easy Time to first run · 5min
Use freely for any purpose including commercial, as long as you keep the copyright notice.

In plain English

This repository is a Traditional Chinese (and Simplified Chinese) translation of the classic essay "How To Ask Questions The Smart Way," originally written by Eric S. Raymond and Rick Moen. The essay is a well-known guide in the software and open-source community that teaches people how to ask technical questions effectively so they are more likely to get helpful answers. The problem it addresses is a common one in online technical communities: many people post vague, poorly structured, or incomplete questions, which frustrates experienced volunteers and often results in no useful reply. This guide explains how to research your problem before asking, how to pick the right forum or mailing list, how to write a clear and informative subject line, how to describe symptoms rather than guesses, and how to follow up after getting an answer. It also covers what behaviors to avoid, such as demanding urgent help, posting homework problems, or being vague about what you already tried. The content itself is hosted as a long Markdown document inside this GitHub repository. It requires no installation or software, you read it directly in a browser or text editor. There is no application to run; this is purely written guidance. You would use this resource if you are new to online technical communities like Stack Overflow, GitHub issues, developer forums, or mailing lists and want to communicate more effectively. It is also useful for team leads or educators who want to share a well-respected, authoritative reference with students or junior developers learning how to seek help productively. The only tech involved is Markdown for the document format. The repository uses JavaScript minimally (likely for tooling or contributors tracking), but the core deliverable is a text document, not a software program.

Copy-paste prompts

Prompt 1
I'm about to ask a question on Stack Overflow. Use this guide to help me rewrite my question so it's clear and gets better answers.
Prompt 2
Show me the key mistakes people make when asking technical questions, and how to avoid them based on this essay.
Prompt 3
I'm a team lead. How can I use this guide to teach my junior developers to ask better questions?
Open on GitHub → Explain another repo

Generated 2026-05-18 · Model: sonnet-4-6 · Verify against the repo before relying on details.