236
edits
GMU:Tutorials/Documentation/Bug Report How-To (view source)
Revision as of 18:25, 30 July 2016
, 30 July 2016no edit summary
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
==How to write a Bug report== | |||
==Introduction== | ===Introduction=== | ||
On this Wiki-page I'll try to explain how you can write a good bug report. | On this Wiki-page I'll try to explain how you can write a good bug report. | ||
The aim of a bug report is to enable the programmer to see the program failing in front of them. You should give them careful and detailed instructions on how to make it fail. If they can reproduce the error, they will try to get as much information until they know the cause. If they can’t reproduce the error, you need to get that information for them. | The aim of a bug report is to enable the programmer to see the program failing in front of them. You should give them careful and detailed instructions on how to make it fail. If they can reproduce the error, they will try to get as much information until they know the cause. If they can’t reproduce the error, you need to get that information for them. | ||
==State the facts…== | ===State the facts…=== | ||
In a bug report you should try to state clear facts what was happening to you when you used | In a bug report you should try to state clear facts what was happening to you when you used | ||
| Line 13: | Line 13: | ||
If you have some speculations what might have happened you can include that but if you aren't sure about it just leave it out, it may cause more confusion than necessary. | If you have some speculations what might have happened you can include that but if you aren't sure about it just leave it out, it may cause more confusion than necessary. | ||
==Be Nice…== | ===Be Nice…=== | ||
When you're writing the report you should write it in a friendly and polite form, it wont help if you insult them or anything in that direction. They may have programmed/developed it but they don't want it too fail when you're using it. | When you're writing the report you should write it in a friendly and polite form, it wont help if you insult them or anything in that direction. They may have programmed/developed it but they don't want it too fail when you're using it. | ||
==You cant just write “It doesn't work”…== | ===You cant just write “It doesn't work”…=== | ||
Like i said above they don't want you to fail while using the program, since they haven't noticed the potential bug the program was running fine for them in their setup. | Like i said above they don't want you to fail while using the program, since they haven't noticed the potential bug the program was running fine for them in their setup. | ||
| Line 26: | Line 26: | ||
What Version/distribution of the Program/Software do you have | What Version/distribution of the Program/Software do you have | ||
==Asking for general help…== | ===Asking for general help…=== | ||
If you are just asking for help and don't want to report a bug, you should tell the programmer where you already looked for information. They may can use this information to make they're own documentation better. | If you are just asking for help and don't want to report a bug, you should tell the programmer where you already looked for information. They may can use this information to make they're own documentation better. | ||
==Show it…== | ===Show it…=== | ||
The best way to report the bug is to show it to the programmer since for example Mr. Hasler cant be here in Person every time you need to figure out another effective way to show them. They need to see how you start the PC, run the Software, see how you interact with it and how the Software responses. This step is very important so that they can try to reproduce the bug by themselves in order to fix it. | The best way to report the bug is to show it to the programmer since for example Mr. Hasler cant be here in Person every time you need to figure out another effective way to show them. They need to see how you start the PC, run the Software, see how you interact with it and how the Software responses. This step is very important so that they can try to reproduce the bug by themselves in order to fix it. | ||
| Line 54: | Line 54: | ||
send them the specs of the other on too | send them the specs of the other on too | ||
==Works for them but not for you…== | ===Works for them but not for you…=== | ||
If the programmer recreated your commands/inputs/actions/… and it works for them you may haven't given them enough information. Maybe the error doesn't appear on every Computer. | If the programmer recreated your commands/inputs/actions/… and it works for them you may haven't given them enough information. Maybe the error doesn't appear on every Computer. | ||
| Line 71: | Line 71: | ||
At this point the programmer still wants to reproduce your failure, they need to know what and where it has gone wrong. Write the errors down message and number are equally important, even if the computer cant give you out the information in words theres still important information in numbers or signs he's outputting. | At this point the programmer still wants to reproduce your failure, they need to know what and where it has gone wrong. Write the errors down message and number are equally important, even if the computer cant give you out the information in words theres still important information in numbers or signs he's outputting. | ||
==And then i tried this to solve the Problem…== | ===And then i tried this to solve the Problem…=== | ||
You probably have done some things after the bug showed up too you to fix it yourself, these action may have made things worse or changed something the programmer cant easily reproduce. Try to remember what you did afterwards and also give detailed information about that. | You probably have done some things after the bug showed up too you to fix it yourself, these action may have made things worse or changed something the programmer cant easily reproduce. Try to remember what you did afterwards and also give detailed information about that. | ||
If you're not sure what you're doing, don't do anything after the bug shows up you will make it worse! | If you're not sure what you're doing, don't do anything after the bug shows up you will make it worse! | ||
| Line 83: | Line 83: | ||
==Sometimes it works…== | ===Sometimes it works…=== | ||
If you're confronted with a bug that just occurs from time to time try to search for a pattern in it. Try different setups several times and write down how many times the bug occurred and what differs to the times it was working. | If you're confronted with a bug that just occurs from time to time try to search for a pattern in it. Try different setups several times and write down how many times the bug occurred and what differs to the times it was working. | ||
| Line 102: | Line 102: | ||
==Be specific no matter you're writing in english or german…== | ===Be specific no matter you're writing in english or german…=== | ||
Don't just tell them i loaded that file into it, tell them how you loaded it by pressing keys, typing a command line or using graphical buttons. This can matter too. Write more than they actually need to know they're willing to ignore the information that isn't needed over getting to less information. | Don't just tell them i loaded that file into it, tell them how you loaded it by pressing keys, typing a command line or using graphical buttons. This can matter too. Write more than they actually need to know they're willing to ignore the information that isn't needed over getting to less information. | ||
| Line 111: | Line 111: | ||
==Asking for general help…== | ===Asking for general help…=== | ||
If you are just asking for help and don't want to report a bug, you should tell the programmer where you already looked for information. They may can use this information to make they're own documentation better. | If you are just asking for help and don't want to report a bug, you should tell the programmer where you already looked for information. They may can use this information to make they're own documentation better. | ||
==Summary== | ===Summary=== | ||
1. Let the programmer see what you've seen | 1. Let the programmer see what you've seen | ||
| Line 138: | Line 138: | ||
11. Be sure you're description cant be misinterpreted | 11. Be sure you're description cant be misinterpreted | ||
==Performance Platform Specific== | ===Performance Platform Specific=== | ||
You can reach the team of Captury via mail or by calling them: | You can reach the team of Captury via mail or by calling them: | ||