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

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/ryanhanwu-how-to-ask-questions-the-smart-way).**

35,230 stars · 5,828 forks · JavaScript · MIT

## Links

- GitHub: https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way
- awesome-repositories: https://awesome-repositories.com/repository/ryanhanwu-how-to-ask-questions-the-smart-way.md

## Topics

`rtfm` `stfw` `translation`

## Description

This project is a technical communication guide and developer support manual designed to help users frame high-quality technical questions to obtain helpful answers from online communities. It provides a structured troubleshooting framework for isolating problems and searching archives before requesting assistance from subject matter experts.

The guide covers professional social norms and etiquette required to maintain a positive reputation within developer forums. It includes instructions on managing community interactions and following up after resolutions to handle technical social interactions professionally.

The project also details methods for structuring inquiries using descriptive titles and symptom-based reporting. It provides guidance on navigating support forums, writing helpful responses to others, and improving project documentation by identifying common points of confusion.

## Tags

### Development Tools & Productivity

- [Developer Support Resources](https://awesome-repositories.com/f/development-tools-productivity/developer-support-resources.md) — Serves as a practical guide for developers to navigate and contribute effectively to technical support communities.
- [Documentation](https://awesome-repositories.com/f/development-tools-productivity/tooling-catalogs/operational-catalogs/feedback-loops/documentation.md) — Implements a mechanism to improve public documentation by identifying and resolving common points of user confusion.

### Education & Learning Resources

- [Technical Communication Frameworks](https://awesome-repositories.com/f/education-learning-resources/technical-communication-frameworks.md) — Offers a structured set of behavioral rules for framing technical questions to obtain high-quality answers.
- [Community Collaboration](https://awesome-repositories.com/f/education-learning-resources/educational-resources/career-interview-community/community-collaboration.md) — Provides professional guidelines for managing social interactions and collaboration within developer communities. ([source](https://github.com/ryanhanwu/how-to-ask-questions-the-smart-way#readme))
- [Community Etiquette](https://awesome-repositories.com/f/education-learning-resources/open-source-guides/community-etiquette.md) — Offers comprehensive guidelines on professional social norms and etiquette for maintaining a positive reputation in developer forums.
- [Technical Communication](https://awesome-repositories.com/f/education-learning-resources/professional-development-career/career-development/professional-skills/technical-communication.md) — Establishes principles for clear technical communication and articulating complex problems to peers in online communities.
- [Technical Community Etiquette](https://awesome-repositories.com/f/education-learning-resources/technical-community-etiquette.md) — Provides a guide on the professional social norms and etiquette required in developer forums.
- [Problem Decomposition Frameworks](https://awesome-repositories.com/f/education-learning-resources/technical-domain-education/computer-science-education/algorithmic-problem-solving/recursive-problem-solving/problem-decomposition-frameworks.md) — Provides a structured framework for isolating technical problems and decomposing them before seeking help.
- [Technical Inquiry Skills](https://awesome-repositories.com/f/education-learning-resources/technical-inquiry-skills.md) — Teaches users how to frame technical inquiries using specific guidelines to attract accurate expert responses. ([source](https://github.com/ryanhanwu/how-to-ask-questions-the-smart-way#readme))
- [Technical Research Strategies](https://awesome-repositories.com/f/education-learning-resources/technical-research-strategies.md) — Provides a structured process for researching existing knowledge bases to reduce redundant community inquiries.
- [Technical Writing](https://awesome-repositories.com/f/education-learning-resources/technical-writing.md) — Provides specific guidelines on structuring technical inquiries using descriptive titles and symptom lists. ([source](https://github.com/ryanhanwu/how-to-ask-questions-the-smart-way#readme))
- [Technical Inquiry Framing](https://awesome-repositories.com/f/education-learning-resources/technical-writing/technical-inquiry-framing.md) — Provides a detailed framework for writing clear and effective technical questions to attract helpful answers from experts.
- [Troubleshooting Preparations](https://awesome-repositories.com/f/education-learning-resources/troubleshooting-preparations.md) — Instructs users to search archives and test hypotheses before asking questions to demonstrate due diligence. ([source](https://github.com/ryanhanwu/how-to-ask-questions-the-smart-way#readme))
- [Community Forums](https://awesome-repositories.com/f/education-learning-resources/community-forums.md) — Helps users identify and select appropriate community forums for technical knowledge exchange. ([source](https://github.com/ryanhanwu/how-to-ask-questions-the-smart-way#readme))
- [Community Support](https://awesome-repositories.com/f/education-learning-resources/educational-resources/career-interview-community/community-collaboration/community-support.md) — Explains how to navigate and select appropriate community support pathways based on problem scope.
- [Support Navigation Guides](https://awesome-repositories.com/f/education-learning-resources/support-navigation-guides.md) — Guides users in selecting the appropriate community or mailing list based on the complexity of their problem.
- [Technical Mentorship Guidelines](https://awesome-repositories.com/f/education-learning-resources/technical-mentorship-guidelines.md) — Guides experienced developers on how to write helpful responses and support beginners in technical forums. ([source](https://github.com/ryanhanwu/how-to-ask-questions-the-smart-way#readme))

### Artificial Intelligence & ML

- [Symptom-Based Reporting](https://awesome-repositories.com/f/artificial-intelligence-ml/automated-reporting/bug-report-templates/symptom-based-reporting.md) — Provides a methodology for reporting bugs using chronological symptoms and specific system details.

### Content Management & Publishing

- [Technical Documentation](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/technical-documentation.md) — Guidelines for creating technical documentation and bug reports based on chronological observed behaviors.

### Software Engineering & Architecture

- [Reputation Building Strategies](https://awesome-repositories.com/f/software-engineering-architecture/project-management-governance/project-management/project-member-assignments/reputation-systems/reputation-building-strategies.md) — Details social norms and professional behaviors to build a positive reputation within technical communities.
- [Troubleshooting Methodologies](https://awesome-repositories.com/f/software-engineering-architecture/troubleshooting-methodologies.md) — Implements a structured troubleshooting framework to isolate problems and search archives before requesting expert assistance.
- [UX Guideline Frameworks](https://awesome-repositories.com/f/software-engineering-architecture/ux-guideline-frameworks.md) — Provides a structured framework of guidelines for framing technical inquiries to improve response quality.
