Welcome to the Java Programming Forums


The professional, friendly Java community. 21,500 members and growing!


The Java Programming Forums are a community of Java programmers from all around the World. Our members have a wide range of skills and they all have one thing in common: A passion to learn and code Java. We invite beginner Java programmers right through to Java professionals to post here and share your knowledge. Become a part of the community, help others, expand your knowledge of Java and enjoy talking with like minded people. Registration is quick and best of all free. We look forward to meeting you.


>> REGISTER NOW TO START POSTING


Members have full access to the forums. Advertisements are removed for registered users.

Results 1 to 6 of 6

Thread: How to Help Yourself Get Help

  1. #1
    Administrator copeg's Avatar
    Join Date
    Oct 2009
    Location
    US
    Posts
    5,301
    Thanks
    181
    Thanked 824 Times in 767 Posts
    Blog Entries
    5

    Default How to Help Yourself Get Help

    How you phrase a question goes hand in hand with the answers you will receive. A well formed question often receives a well formed answer. A poorly formed question a general answer, if any at all. Below are some tips to help one form a question in a manner that increases the chances of receiving help:

    Ask a specific question. General out of context question - such as 'what am I doing wrong' or 'I'm stuck, what do I do next', or just posting a homework assignment - makes it difficult for contributors to point you in the right direction. Rather, rephrasing these questions - 'I get the following compile time error in the following code, what is causing it and why?' followed by the code and error - results in much more context and makes it much easier for contributors to answer. When posting questions specific about code, you should ask and answer the following question (and information such as error messages and stack traces to the question itself).
    • Does it compile?
    • Are there exceptions?
    • Does it function as expected?


    Be descriptive. Don't assume others know what you are talking about, know what your code should do, or know of any errors that are not posted…more often than not, we don't. If there are exceptions, post the full stack trace. If it does not compile, post the error message(s). If it misbehaves, post what you expect and what you get.

    Use a descriptive title. Titles such as "I need help" or "Help" do little to describe your problem. The title is as important as the post itself.

    Don't just post a homework assignment. The forums are not a code service, homework service, and we definitely will not help you cheat. If a posts shows an effort, than contributors will make an effort. If no effort is shown, no effort will be given.

    Post in the correct forum. Some users are experts in one thing, other users another…and each might browse a particular forum topic. Choose wisely: doing so opens your post to the appropriate audience.

    Use the code tags ([highlight=java]Code Goes Here[/highlight]). These tags makes code readable, as does proper indenting, comments, standard java syntax, etc...

    Post an SSCCE (Short, self contained, compilable, correct example). Strip away code that does not matter, avoid posting huge volumes of code, and post code that clearly demonstrates the problem in as few lines as possible. Oftentimes, the process of taking volumes of code and stripping it down the problem at hand will reveal the answer. If not, it helps others spot problems much easier.
    Short, Self Contained, Correct Example

    Do your research. Did you try a forum search or google? Oftentimes a question can be answered much faster by simply investing a few seconds with a search. And oftentimes if this is the case, all you will receive is an answer in the forums containing a link to google or the top hit in google.

    Write Legibly. Text message shorthand, screaming (exclamation points, all caps, large fonts), and other types of writing that are not standard english grammer could hurt your chances of receiving help. It can often times be hard to read, but more importantly perceived as rude, lazy, and selfish. If you don't spend the time writing legibly, if you think your post is more important than anyone else, why should anyone spend their time trying to respond?

    Avoid demonstrating urgency Urgency is relative - all questions to the forums are 'urgent' for the person that posted it. Stating this in a post not only makes your post convey selfishness - as if your post is more important than anyone else - but can also be perceived as rude by contributors, with the perception that your time is more valuable than theirs. Don't bite the hand that feeds you.

    Try different things…then do it again. Programming is a workflow, which includes several rounds of making changes, compilation, and debugging/testing. Adding System.out.println statements lets one evaluate the value of a variable during runtime, and a debugger is invaluable for stepping through code to analyze the progress of a program. The point is to try, and oftentimes responses to posts will be just that: what did you try?

    Remember, contributors to the forums do so on their own free time, unpaid. While all contributors do their best to help, when it comes down to it you are responsible for your code, and you are responsible for finding the answers. There are hundreds of posts here, and keeping up with them can be difficult. Posts that contain well formed questions encourage contributors to reply and get your question answered that much faster.

    Further reading:
    How to Ask Questions the Smart Way
    SSCCE
    How to Program when Stuck
    Technical Forums: What not to do
    Last edited by copeg; October 12th, 2011 at 11:09 AM.

  2. The Following 7 Users Say Thank You to copeg For This Useful Post:

    Admin (November 16th, 2012), B33R4NG (July 5th, 2012), Freaky Chris (October 30th, 2011), javapenguin (October 9th, 2011), JavaPF (October 10th, 2011), KevinWorkman (October 10th, 2011), newbie (October 9th, 2011)

  3. #2
    Forum Squatter newbie's Avatar
    Join Date
    Nov 2010
    Location
    North Wales
    Posts
    661
    My Mood
    Stressed
    Thanks
    28
    Thanked 115 Times in 106 Posts
    Blog Entries
    1

    Default Re: How to Help Yourself Get Help

    Great post, but can only hope every poster goes by this
    Please use [highlight=Java]//code goes here...[/highlight] tags when posting your code

  4. #3
    Administrator copeg's Avatar
    Join Date
    Oct 2009
    Location
    US
    Posts
    5,301
    Thanks
    181
    Thanked 824 Times in 767 Posts
    Blog Entries
    5

    Default Re: How to Help Yourself Get Help

    Quote Originally Posted by newbie View Post
    Great post, but can only hope every poster goes by this
    Thanks. It is meant more to link to in replies to posts to those who don't read this or follow the advice. I have written some portions of the above dozens if not hundreds of times...its much easier to write once here, and post a link there.

  5. #4
    Banned
    Join Date
    May 2010
    Location
    North Central Illinois
    Posts
    1,631
    My Mood
    Sleepy
    Thanks
    390
    Thanked 112 Times in 110 Posts

    Default Re: How to Help Yourself Get Help

    Quote Originally Posted by copeg View Post
    Thanks. It is meant more to link to in replies to posts to those who don't read this or follow the advice. I have written some portions of the above dozens if not hundreds of times...its much easier to write once here, and post a link there.
    Once again, what if you've no earthly idea what's causing the problem? I mean, it could be a problem in class B that uses class A the wrong way or it could be a direct error in class A even if B is using it "right".

  6. #5
    Administrator copeg's Avatar
    Join Date
    Oct 2009
    Location
    US
    Posts
    5,301
    Thanks
    181
    Thanked 824 Times in 767 Posts
    Blog Entries
    5

    Default Re: How to Help Yourself Get Help

    Quote Originally Posted by javapenguin View Post
    Once again, what if you've no earthly idea what's causing the problem? I mean, it could be a problem in class B that uses class A the wrong way or it could be a direct error in class A even if B is using it "right".
    I have no idea what you mean by 'once again'...but that is beside the point. To answer your qeustion: it shouldn't matter - the point is to describe the symptoms of the problem. In the example you gave, read the 3 bullet points in the first section titled "Ask a Specific Question" - this (I presume) would be a case of the last bullet point. So then, what are the symptoms? In many cases, without knowing what the expected output is (at the minimum), we can't guess how to correct the problem - and often when one does guess, it can be unproductive, incorrect, or often lead the original poster completely astray.

  7. The Following 2 Users Say Thank You to copeg For This Useful Post:

    JavaPF (October 10th, 2011), Nieuwenhuizen-jk (October 20th, 2011)

  8. #6
    Crazy Cat Lady KevinWorkman's Avatar
    Join Date
    Oct 2010
    Location
    Washington, DC
    Posts
    5,357
    My Mood
    Hungover
    Thanks
    144
    Thanked 626 Times in 537 Posts

    Default Re: How to Help Yourself Get Help

    Quote Originally Posted by javapenguin View Post
    Once again, what if you've no earthly idea what's causing the problem? I mean, it could be a problem in class B that uses class A the wrong way or it could be a direct error in class A even if B is using it "right".
    That's when the "How to Program when Stuck" link comes in handy. Also, the process of boiling your problem down to an SSCCE will help you track down its source, which is a big reason we always ask for one. If you don't know what's causing the problem, you take out anything NOT causing the problem. When you're only left with a few lines, you can ask a specific question about them.
    Useful links: How to Ask Questions the Smart Way | Use Code Tags | Java Tutorials
    Static Void Games - Play indie games, learn from game tutorials and source code, upload your own games!

  9. The Following 2 Users Say Thank You to KevinWorkman For This Useful Post:

    copeg (October 11th, 2011), JavaPF (October 10th, 2011)