- Describe the minimal case needed to demonstrate the problem.
Please try to find the minimal case (that is, the fewest steps) in which you can demonstrate the problem. Including unnecessary steps can sometimes result in the developer focusing on the wrong areas.
- Describe what you were trying to do, in exact detail.
Walk the reader through the steps you took and what you were trying to do.
Avoid the use of pronouns when describing parts of the system. For example:
Not specific enough: I downloaded the Upgrade.tar file and rebooted it.
Good specifics: I downloaded the Build 1.0.1 Upgrade.tar file and performed a soft reboot of the AP using the Advanced > Reboot feature.
Include a copy of (or reference to) the test case description or user documentation you were following. Indicate the following information.
- Product name
- Version
- Build number (if you know it)
- Load number (if you know it)
- Branch (if you know it)
- Edition
- Development platform (if applicable)
- AP target platform
- CD (if applicable)
|
Note
|
Build, load, and branch numbers will generally not be know by Manufacturing customers but can be provided by Devicescape developers.
|
- Describe what actually happened
Walk the reader through what actually happened including where you got the software, what you did, and what happened. Explain where you got what software you are using (for example, "I downloaded <FileName> from <FullPathOnFTPSite>, burned it to a CD, and booted that on an access point" or "I downloaded <BuildName/Number> Upgrade.tar file through the Administration UI.")
Include transcripts of what you did. For actions on the host PC, you may find the "script" program useful; for actions on the target, capture output from your terminal program to a file. Include everything from when the system booted.
Include the starting configuration: the apconfig.xml file, a screen shot of the UI screen, or just a list of fields and settings showing what parameters the UI fields were set to.
- Describe what you were expecting to see.
Walk the reader though what you were expecting to see, in exact detail. If there was a message you expected to appear but did not, cite the message. If there was an error you weren't expecting, point out the location of the error within the transcripts.
- Indicate Whether the Bug is Known to be Reproducible
Indicate whether you can reproduce this bug never, occasionally, or always - that is, repeat the entire process above and get the same result. If so, reserve the resources to be able to repeat the process for a developer so that they can watch what happens and inspect the end result.
Indicate whether this bug is preventing you from doing anything else. (Ideally there should be multiple, independent test assignments so that the answer is usually "no".)
