Development

HowToAskQuestions (diff)

You must first sign up to be able to contribute.

Changes between Version 8 and Version 9 of HowToAskQuestions

Show
Ignore:
Author:
halfer (IP: 195.137.53.121)
Timestamp:
10/26/06 01:33:47 (11 years ago)
Comment:

Minor tweaks to chtito's changes, as requested

Legend:

Unmodified
Added
Removed
Modified
  • HowToAskQuestions

    v8 v9  
    11= Introduction = 
    22 
    3 From helping out a number of symfony beginners in the forum, it seems that some of the same questions crop up time and again, and that the way in which questions are asked can sometimes be improved upon, so that more experienced members don't have to ask for further information. This page has been added by '''halfer''', contact details are available in my forum profile if required. It is a work in progress. Feel free to add stubs, or full material to this, at will
     3From helping out a number of symfony beginners in the forum, it seems that some of the same questions crop up time and again, and that the way in which questions are asked can sometimes be improved upon, so that more experienced members don't have to ask for further information. This page is a work in progress. Feel free to add stubs, or full material to this, at will. A relevant discussion in the fora is [http://www.symfony-project.com/forum/index.php/t/3408/ here]
    44 
    55= How to ask for help = 
    77== Do a search on the problem first == 
    88 
    9 A good place to start is the symfony fora, especially if you feel the problem is down more to symfony than, say, Apache or PHP. Type one or two keywords in the search box, and see what that brings up. If your problem is directly related to an existing post, then if necessary, add a further question to that thread, rather than starting a new one. Bear in mind that the search engine isn't great, so try two or three searches before assuming that your topic has not already been covered. 
     9A good place to start are the [http://www.symfony-project.com/forum/index.php/i/ symfony fora], especially if you feel the problem is down more to symfony than, say, Apache or PHP. Type one or two keywords in the search box, and see what that brings up. If your problem is directly related to an existing post, then if necessary, add a further question to that thread, rather than starting a new one. Bear in mind that the search engine isn't great, so try two or three searches before assuming that your topic has not already been covered. 
    1010 
    1111Some questions are more to do with external things, such as PEAR, PHP, your webserver, or your environment. Sometimes these issues are discussed on the fora (eg what bugs a particular version of PHP might have), but don't be afraid to reach for your favourite search engine. 
    1515== Try it first == 
    1616 
    17 If you find a solution to your problem, either in the fora or elsewhere, try it! If you are having installation problems, consult the various tutorials in the wiki, or in the first project. If you are having a particular difficulty, and it has been covered before, follow the suggestions or examples you find, and see if you can get it to work yourself. Not only is this a good way to learn, but again, '''people will be more likely to offer assistance if you have given it a good shot already'''. 
     17If you find a solution to your problem, either in the fora or elsewhere, try it! If you are having installation problems, consult the various tutorials in the wiki, or in the first project. If you are having a particular difficulty, and it has been covered before, follow the suggestions or examples you find, and see if you can get it to work yourself. Not only is this a good way to learn, but again, '''people will be more likely to offer assistance if you have given it a good shot first'''. 
    1818 
    1919== Keep questions concise, clear, and in the right place ==  
    2323Check that you are posting to the correct forum, too. Feature requests have their own section, as do general questions, support questions, discussions on plugins, and so forth. Ensure that you are posting on the right thread as well: don't start a new topic on an unconnected, existing, conversation. 
    2424 
    25 '''When you ask a question, provide all the relevant information.''' Your symfony version number, or at least the build (eg "the latest alpha") is very relevant. Also, the version of PHP you are running, and your OS (*nix, Windows, Mac?). The Apache web server will generally be assumed, so if you are using IIS or some other product, say so. 
     25'''When asking a question, provide all the relevant information.''' Your symfony version number, or at least the build (eg "the latest alpha") is very relevant. Also, the version of PHP you are running, and your OS (*nix, Windows, Mac?). The Apache web server will generally be assumed, so if you are using IIS or some other product, say so. 
    2626 
    2727== Don't run before you can walk == 
    3535That all said, if you seem willing to put the necessary time and effort in, you will often find people in the symfony fora who are happy to help you out, even if you are new to some of the necessary concepts. 
    3636 
    37 Lastly, '''take a good look at the askeet tutorial before posting any question''' since many common tasks are already addressed there. 
     37Lastly, if you can, '''take a good look at the askeet tutorial before posting questions''', since many common tasks are already addressed there. 
    3838 
    3939== How to deal with delay == 
    4343Alternatively, whilst your question is sitting in the forum unanswered, work on something else. Come back to it later, at which point you may well have had a 'eureka moment' yourself, or you may have garnered some answers. 
    4444 
    45 If your question remains unanswered after a day or two, then 'ping' it by adding a ''polite'' re-ask at the end. Don't chase every couple of hours, and generally speaking, don't chase more than once or twice. If your thread is stubbornly not attracting any attention, then consider re-phrasing your question, or simplifying it. Make sure it is to the point, otherwise it becomes a chore for others to read through. 
    46  
    47 And remember that '''most often, if you get no answer to your question it is because the question is not asked properly''', as explained above. 
     45If your question remains unanswered after a day or two, then 'ping' it by adding a ''polite'' re-ask at the end. Don't chase every couple of hours, and generally speaking, don't chase more than once or twice. '''If your thread is stubbornly not attracting any attention, then consider re-phrasing your question, or simplifying it'''. Make sure it is to the point, otherwise it becomes a chore for others to read through. 
    4846 
    4947== Be nice == 
    5553== Be helpful == 
    5654 
    57 First of all, '''if you managed to solve what you asked for in the forum, always post the solution'''. Nothing is more irritating than users answering to themselves: "never mind, I solved it". 
     55Again, '''if you manage to solve what you asked for in the forum, please post the solution'''. Nothing is more frustrating to users reading a thread that describes their problem, but finding that it finishes with a message saying only "never mind, I solved it". 
    5856 
    59 Once you get going with symfony, you will have more knowledge on it than people who are completely new to it. So, if you see someone struggling to get going, offer them some help, especially if you have received assistance yourself in the past. If you discover a bug, then discuss it in a forum, and if it is agreed that it is a fault, raise a trac ticket on it (there are instructions on getting an account on the tickets page). 
     57Once you get going with symfony, you will have more knowledge on it than people who are completely new to it. So, if you see someone struggling on the basics, offer them some help - especially if you have received assistance yourself in the past. If you discover a bug, then discuss it in a forum, and if it is agreed that it is a fault, raise a trac ticket on it (there are instructions on getting an account on the tickets page). 
    6058 
    6159Good luck!